Click or drag to resize

UIControl Class

Base class of all UI controls.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public class UIControl : Component, IVisibleInHierarchy

The UIControl type exposes the following members.

Constructors
  NameDescription
Public methodUIControl
Initializes a new instance of the UIControl class
Top
Properties
  NameDescription
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBackgroundColor
The background color of the control.
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCanBeSelected
Whether the object is selectable in editor view.
Public propertyCanBeSelectedInHierarchy
Public propertyCanClone
Whether the control is cloneable.
Public propertyCanFocus
Whether control can be focused.
Public propertyCapture
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyColorMultiplier
The extra color multiplier applied to the control.
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyCoverOtherControls
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEditorScrollPosition
The editor scroll position of the control.
Public propertyEditorZoomIndex
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public propertyEnabledInHierarchy
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledInHierarchyAndIsNotResource
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyFocused
Whether the control is focused or not.
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyHorizontalAlignment
The horizontal alignment of the control.
Public propertyMargin
The margin of the control.
Public propertyMousePosition
The current mouse pointer position.
Public propertyMouseRelativeMode
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentContainer
The parent container of the control.
Public propertyParentControl
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyReadOnly
Whether the control is read-only.
Public propertyReadOnlyInHierarchy
Whether the control is read-only in hierarchy.
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenClipRectangle
The clip rectangle of the control.
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertySize
The size of the control.
Public propertySpecialShader
The special shader of the control.
Public propertySpecialShaderApplyToChildren
Whether special shader is applied to children.
Public propertyStyle
The style of the control.
Public propertyText
The text value of the control.
Public propertyTime
Public propertyTopMost
Whether the control is rendered on the top.
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyVerticalAlignment
The vertical alignment of the control.
Public propertyVisible
Whether the control is visible.
Public propertyVisibleInHierarchy
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodConvertLocalToScreen(Rectangle)
Public methodConvertLocalToScreen(Vector2)
Public methodConvertOffset
Public methodConvertOffsetX
Public methodConvertOffsetY
Public methodConvertScreenToLocal(Rectangle)
Public methodConvertScreenToLocal(Vector2)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFocus
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLocalOffsetByValue
Public methodGetParentContainerSizeInPixels
Public methodGetParentContainerSizeInUnits
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetScreenOffsetByValue
Public methodGetScreenOffsetByValueX
Public methodGetScreenOffsetByValueY
Public methodGetScreenPosition
Public methodGetScreenRectangle
Public methodGetScreenRectangle(Rectangle)
Public methodGetScreenSize
Public methodGetStyle
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Protected methodOnAddedToParent (Overrides ComponentOnAddedToParent.)
Protected methodOnAfterRenderUIWithChildren
Protected methodOnBeforeRenderUIWithChildren
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved (Overrides ComponentOnComponentRemoved(Component).)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDisabledInSimulation
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component.)
Protected methodOnEnabledInSimulation
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnJoystickEvent
Protected methodOnKeyDown
Protected methodOnKeyDownBefore
Protected methodOnKeyPress
Protected methodOnKeyPressBefore
Protected methodOnKeyUp
Protected methodOnKeyUpBefore
Protected methodOnLoad
Called during object loading.
(Inherited from Component.)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter
Called when filtering receive members of the object metadata.
(Inherited from Component.)
Protected methodOnMouseDoubleClick
Protected methodOnMouseDoubleClickBefore
Protected methodOnMouseDown
Protected methodOnMouseDownBefore
Protected methodOnMouseMove
Protected methodOnMouseUp
Protected methodOnMouseUpBefore
Protected methodOnMouseWheel
Protected methodOnMouseWheelBefore
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnRemovedFromParent (Overrides ComponentOnRemovedFromParent(Component).)
Protected methodOnRenderUI
Protected methodOnResize
Protected methodOnSave
Called during object saving.
(Inherited from Component.)
Protected methodOnSimulationStep
Called during the simulation step.
(Inherited from Component.)
Protected methodOnSpecialInputDeviceEvent
Protected methodOnTouch
Protected methodOnUpdate
Called during the update process of all objects.
(Inherited from Component.)
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent (Overrides ComponentRemoveFromParent(Boolean).)
Public methodResetCreateTime
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Public methodUnfocus
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventAfterRenderUIWithChildren
Public eventBackgroundColorChanged
Public eventBeforeRenderUIWithChildren
Public eventCanBeSelectedChanged
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventColorMultiplierChanged
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisabledInSimulation
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
Public eventEnabledInSimulation
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventHorizontalAlignChanged
Public eventJoystickEvent
Public eventKeyDown
Public eventKeyDownBefore
Public eventKeyPress
Public eventKeyPressBefore
Public eventKeyUp
Public eventKeyUpBefore
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMarginChanged
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventMouseDoubleClick
Public eventMouseDoubleClickBefore
Public eventMouseDown
Public eventMouseDownBefore
Public eventMouseEnter
Public eventMouseLeave
Public eventMouseMove
Public eventMouseUp
Public eventMouseUpBefore
Public eventMouseWheel
Public eventMouseWheelBefore
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventReadOnlyChanged
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventRenderUI
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSizeChanged
Public eventSpecialInputDeviceEvent
Public eventStyleChanged
Public eventTextChanged
Public eventTopMostChanged
Public eventTouch
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventVerticalAlignChanged
Public eventVisibleChanged
Top
Extension Methods
See Also
Inheritance Hierarchy
SystemObject
  NeoAxisComponent
    NeoAxisUIControl
      NeoAxisUIButton
      NeoAxisUICheck
      NeoAxisUICombo
      NeoAxisUIContainer
      NeoAxisUIContextMenu
      NeoAxisUIEdit
      NeoAxisUIGrid
      NeoAxisUIImage
      NeoAxisUIList
      NeoAxisUIMenu
      NeoAxisUIProgress
      NeoAxisUIRenderTarget
      NeoAxisUIScroll
      NeoAxisUISlider
      NeoAxisUISplitContainer
      NeoAxisUITabControl
      NeoAxisUIText
      NeoAxisUIToolbar
      NeoAxisUITree
      NeoAxisUIVideo
      NeoAxisUIWebBrowser
      NeoAxisUIWindow