Click or drag to resize

ControlScreen Class

Application can contain multiple screens, but only 1 screen is displayed at a time. Screen control contains collection of all controls present in a screen. Each control in a screen must have a name unique to the screen.
Inheritance Hierarchy
SystemObject
  AxiomCore2.ControlsControlBase
    AxiomCore2.ControlsControlScreen

Namespace: AxiomCore2.Controls
Assembly: Canary.Axiom.Session (in Canary.Axiom.Session.exe) Version: 25.6.0.25344+3070493948bf7d32a86bd3e9a8bcf4cc9a5b1929
Syntax
C#
Copy
public sealed class ControlScreen : ControlBase, 
	IControlParent, IControlBase, IDisposable

The ControlScreen type exposes the following members.

Properties
 NameDescription
Public propertyAssetBranchCount Number of branches to display in asset picker.
Public propertyAssetInstance Fully qualified asset instance of a control. Default value is null.
Public propertyAssetPickerInlineWidth Width of the asset picker in pixels when a control's PropertyAssetPickerMode property is set to Inline.
Public propertyAssetPickerMode Mode used by control to change an asset instance. See PropertyAssetPickerMode for mode descriptions. Default value is Modal
Public propertyCode exampleChildren Collection of child controls. Add, remove, index, iterate and more using the IControlChildren interface.
Public propertyHeight Height of control in pixels.
Public propertyIsAssetInstanceValid Validity of asset instance. Default value is null;
Public propertyIsCurrentScreen Returns true if screen is currently visible.
Public propertyIsNavigationVisible Determines whether screen should be visible in client tab navigation. If not visible, client must use a navigation event or script to show screen.
Public propertyKind Kind of control.
(Inherited from ControlBase)
Public propertyName Control name that is unique within the owning screen. Name of control must conform to the regex pattern [a-zA-Z0-9], as only letters and numbers are valid characters.
(Inherited from ControlBase)
Public propertyOnBeginAssetChange Name of a method defined in the screen script that will be invoked before the asset instance of a control is changed. Method must have same signature as EventDelegatesOnAssetChange. Default value is null.
Public propertyOnEndAssetChange Name of a method defined in the screen script that will be invoked after the asset instance of a control is changed. Method must have same signature as EventDelegatesOnAssetChange. Default value is null.
Public propertyParent Parent of the control.
(Inherited from ControlBase)
Public propertyScreen Screen the control resides in.
(Inherited from ControlBase)
Public propertyScreenControls Read only collection of all controls present in screen. Each control in a screen must have name unique to the screen. This collection is updated automatically as controls are added or removed from descendant controls of the screen.
Public propertyScript Script used to create custom screen functionality. Controls have events that can trigger script to run. Scripting language is C#. Default value is null.
Public propertyTemplateId Id used to find sibling controls within a template. All siblings will have the same id. Default value is null.
(Inherited from ControlBase)
Public propertyTitle Title of control used for display purposes. Default value is null.
Public propertyWidth Width of control in pixels.
Top
Methods
 NameDescription
Public methodAncestorsT Get ancestor controls that implement generic control interface defined by T.
(Inherited from ControlBase)
Public methodDescendantsT Get descendant child controls that implement generic control interface defined by T.
Top
See Also