UIImage Class |
Standard control that shows an image.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.2.1.0 (2026.2.1.0)
SyntaxC#
public class UIImage : UIControl
The UIImage type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AnyData |
The user data of the component.
(Inherited from Component) |
| BackgroundColor |
The background color of the control.
(Inherited from UIControl) |
| BackgroundRounding |
The background rounding size.
(Inherited from UIControl) |
| BaseType |
Gets the base type of the object.
(Inherited from Component) |
| CanBeSelected |
Whether the object is selectable in editor view.
(Inherited from UIControl) |
| CanBeSelectedInHierarchy | (Inherited from UIControl) |
| CanClone |
Whether the control is cloneable.
(Inherited from UIControl) |
| CanFocus |
Whether control can be focused.
(Inherited from UIControl) |
| Capture | (Inherited from UIControl) |
| Clamp | Specifies the clamp texture address mode. |
| CloneSupport |
Whether the object supports cloning.
(Inherited from Component) |
| ColorMultiplier |
The extra color multiplier applied to the control.
(Inherited from UIControl) |
| Components |
Gets the collection of the child components.
(Inherited from Component) |
| CoverOtherControls | (Inherited from UIControl) |
| CreatedByBaseType |
Whether the object is created using a base type.
(Inherited from Component) |
| DisplayInEditor |
Whether to show the object in the editor.
(Inherited from Component) |
| Disposed |
Whether the object is disposed.
(Inherited from Component) |
| EditorDocumentConfiguration |
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component) |
| EditorReadOnly |
Whether the object is read only in the editor.
(Inherited from Component) |
| EditorReadOnlyInHierarchy |
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component) |
| EditorScrollPosition |
The editor scroll position of the control.
(Inherited from UIControl) |
| EditorZoomIndex | (Inherited from UIControl) |
| Enabled |
Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component) |
| EnabledInHierarchy |
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) |
| EnabledInHierarchyAndIsInstance |
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) |
| Filtering | The filtering mode of the image texture. |
| Focused |
Whether the control is focused or not.
(Inherited from UIControl) |
| HierarchyController |
Gets the object hierarchy control controller.
(Inherited from Component) |
| HorizontalAlignment |
The horizontal alignment of the control.
(Inherited from UIControl) |
| IsResource | (Inherited from Component) |
| Margin |
The margin of the control.
(Inherited from UIControl) |
| MousePosition |
The current mouse pointer position in the local coordinates of the control.
(Inherited from UIControl) |
| MouseRelativeMode | (Inherited from UIControl) |
| Name |
The name of the component.
(Inherited from Component) |
| NetworkID | (Inherited from Component) |
| NetworkIsClient | (Inherited from Component) |
| NetworkIsServer |
Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component) |
| NetworkIsSingle | (Inherited from Component) |
| NetworkIsSingleOrClient | (Inherited from Component) |
| NetworkMode |
Whether to enable synchronization of the component between server and clients.
(Inherited from Component) |
| NetworkModeUsers | (Inherited from Component) |
| Parent |
Gets the parent object.
(Inherited from Component) |
| ParentContainer |
The parent container of the control.
(Inherited from UIControl) |
| ParentControl | (Inherited from UIControl) |
| ParentRoot |
Gets the parent root object.
(Inherited from Component) |
| ParentScene |
Gets the parent scene object.
(Inherited from Component) |
| ReadOnly |
Whether the control is read-only.
(Inherited from UIControl) |
| ReadOnlyInHierarchy |
Whether the control is read-only in hierarchy.
(Inherited from UIControl) |
| RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
(Inherited from Component) |
| SaveSupport |
Whether the object supports saving to a file.
(Inherited from Component) |
| ScreenClipRectangle |
The clip rectangle of the control.
(Inherited from UIControl) |
| ScreenLabel |
The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component) |
| Size |
The size of the control.
(Inherited from UIControl) |
| SourceImage | The source texture of the image. |
| SpecialShader |
The special shader of the control.
(Inherited from UIControl) |
| SpecialShaderApplyToChildren |
Whether special shader is applied to children.
(Inherited from UIControl) |
| Style |
The style of the control.
(Inherited from UIControl) |
| Text |
The text value of the control.
(Inherited from UIControl) |
| TextureCoordinates | The UV coordinates of the image texture. |
| TextureCoordinatesRotation | The rotation of UV coordinates around the center. |
| Time | (Inherited from UIControl) |
| TopMost |
Whether the control is rendered on the top.
(Inherited from UIControl) |
| TypeSettingsPrivateObjects |
Object settings when used as a type.
(Inherited from Component) |
| VerticalAlignment |
The vertical alignment of the control.
(Inherited from UIControl) |
| Visible |
Whether the control is visible.
(Inherited from UIControl) |
| VisibleInHierarchy | (Inherited from UIControl) |
Methods| Name | Description | |
|---|---|---|
 | AddComponent |
Adds a component as a child.
(Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessageToEveryone | (Inherited from Component) |
| BeginNetworkMessageToServer | (Inherited from Component) |
| Clone |
Creates a copy of the object.
(Inherited from Component) |
| ConvertLocalToScreen(Rectangle) | (Inherited from UIControl) |
| ConvertLocalToScreen(Vector2) | (Inherited from UIControl) |
| ConvertOffset | (Inherited from UIControl) |
| ConvertOffsetX | (Inherited from UIControl) |
| ConvertOffsetY | (Inherited from UIControl) |
| ConvertScreenToLocal(Rectangle) | (Inherited from UIControl) |
| ConvertScreenToLocal(Vector2) | (Inherited from UIControl) |
| CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| Dispose |
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindParent(Type) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParent(MetadataTypeInfo) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParentT |
Finds the parent of the specified type.
(Inherited from Component) |
| FindThisOrParent(Type) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParent(MetadataTypeInfo) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParentT |
Finds the parent or self of the specified type.
(Inherited from Component) |
| Focus | (Inherited from UIControl) |
| GetAllParents |
Gets all parents of the component.
(Inherited from Component) |
| GetComponent(String, Boolean) |
Finds a child component by name.
(Inherited from Component) |
| GetComponent(Type, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponent(MetadataTypeInfo, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentT(Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentByNameWithIndex |
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component) |
| GetComponentByPath |
Finds a child component by path.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean) |
Finds child components.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) |
Finds child components.
(Inherited from Component) |
| GetComponents(Type, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) |
Finds child components of the specified type.
(Inherited from Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLocalOffsetByValue | (Inherited from UIControl) |
| GetParentContainerPixelScale | (Inherited from UIControl) |
| GetParentContainerSizeInPixels | (Inherited from UIControl) |
| GetParentContainerSizeInUnits | (Inherited from UIControl) |
| GetPathFromParent |
Returns the path to the object from the parent.
(Inherited from Component) |
| GetPathFromRoot |
Returns the object's access path from the root object.
(Inherited from Component) |
| GetProvidedType |
Returns a type when the object is used as a type.
(Inherited from Component) |
| GetScreenLabelInfo | (Inherited from Component) |
| GetScreenOffsetByValue | (Inherited from UIControl) |
| GetScreenOffsetByValueX | (Inherited from UIControl) |
| GetScreenOffsetByValueY | (Inherited from UIControl) |
| GetScreenPosition | (Inherited from UIControl) |
| GetScreenRectangle | (Inherited from UIControl) |
| GetScreenRectangle(Rectangle) | (Inherited from UIControl) |
| GetScreenSize | (Inherited from UIControl) |
| GetStyle | (Inherited from UIControl) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsMethodInvoking |
Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MetadataGetMemberBySignature |
Returns the object metadata member by name.
(Inherited from Component) |
| MetadataGetMembers |
Returns the object metadata members.
(Inherited from Component) |
| MethodInvoke |
Calls a method by name.
(Inherited from Component) |
| MethodInvokeCancel |
Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MethodInvokeCancelAll |
Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| NetworkDisablePropertySynchronization | (Inherited from Component) |
| NetworkIsDisabledPropertySynchronization | (Inherited from Component) |
| NetworkModeAddUser | (Inherited from Component) |
| NetworkModeIsEnabledForUser | (Inherited from Component) |
| NetworkModeRemoveUser | (Inherited from Component) |
| NetworkRestoreDisabledPropertySynchronization | (Inherited from Component) |
| NewObjectSetDefaultConfiguration |
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component) |
| NewObjectSetDefaultConfigurationUpdate |
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component) |
| OnAddedToParent | (Inherited from UIControl) |
| OnAfterRenderUIWithChildren | (Inherited from UIControl) |
| OnBeforeRenderUIWithChildren | (Inherited from UIControl) |
| OnClientConnectedAfterRootComponentEnabled | (Inherited from Component) |
| OnClientConnectedBeforeRootComponentEnabled | (Inherited from Component) |
| OnClientDisconnected | (Inherited from Component) |
| OnClone |
Called when the object is cloned.
(Inherited from Component) |
| OnComponentAdded |
Called when a child component is added.
(Inherited from Component) |
| OnComponentRemoved | (Inherited from UIControl) |
| OnDisabledInSimulation |
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) |
| OnDisabledInSimulationAndIsInstance |
Called when the object is detached from a hierarchy of the components or is disabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnDispose |
Called when the object is disposed.
(Inherited from Component) |
| OnEditorGetTextInfoCenterBottomCorner | (Inherited from Component) |
| OnEnabledChanged |
Called when value of Enabled property is changed.
(Inherited from Component) |
| OnEnabledInHierarchyChanged |
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component) |
| OnEnabledInSimulation |
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) |
| OnEnabledInSimulationAndIsInstance |
Called when the object is attached to a hierarchy of the components, it is enabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnJoystickEvent | (Inherited from UIControl) |
| OnKeyDown | (Inherited from UIControl) |
| OnKeyDownBefore | (Inherited from UIControl) |
| OnKeyPress | (Inherited from UIControl) |
| OnKeyPressBefore | (Inherited from UIControl) |
| OnKeyUp | (Inherited from UIControl) |
| OnKeyUpBefore | (Inherited from UIControl) |
| OnLoad |
Called during object loading.
(Inherited from Component) |
| OnMetadataGetMemberBySignature |
Called when the object metadata member is received by name.
(Inherited from Component) |
| OnMetadataGetMembers |
Called upon receipt of the object's metadata members.
(Inherited from Component) |
| OnMetadataGetMembersFilter |
Called when filtering receive members of the object metadata.
(Inherited from Component) |
| OnMouseDoubleClick | (Inherited from UIControl) |
| OnMouseDoubleClickBefore | (Inherited from UIControl) |
| OnMouseDown | (Inherited from UIControl) |
| OnMouseDownBefore | (Inherited from UIControl) |
| OnMouseMove | (Inherited from UIControl) |
| OnMouseUp | (Inherited from UIControl) |
| OnMouseUpBefore | (Inherited from UIControl) |
| OnMouseWheel | (Inherited from UIControl) |
| OnMouseWheelBefore | (Inherited from UIControl) |
| OnPreloadResources |
Called when preloading the resources used by the object.
(Inherited from Component) |
| OnReceiveNetworkMessageFromClient | (Inherited from Component) |
| OnReceiveNetworkMessageFromServer | (Inherited from Component) |
| OnRemovedFromParent | (Inherited from UIControl) |
| OnRenderUI | (Overrides UIControlOnRenderUI(CanvasRenderer)) |
| OnResize | (Inherited from UIControl) |
| OnSave |
Called during object saving.
(Inherited from Component) |
| OnSimulationStep |
Called during the simulation step.
(Inherited from Component) |
| OnSimulationStepClient |
Called during the simulation step.
(Inherited from Component) |
| OnSpecialInputDeviceEvent | (Inherited from UIControl) |
| OnTouch | (Inherited from UIControl) |
| OnUpdate |
Called during the update process of all objects.
(Inherited from Component) |
| PreloadResources |
Preload resources used by the object.
(Inherited from Component) |
| PropertyGet(String, Object, Boolean) |
Gets the value of a property by name.
(Inherited from Component) |
| PropertySet |
Sets the value of a property by name.
(Inherited from Component) |
| RemoveAllComponents |
Removes all child components.
(Inherited from Component) |
| RemoveComponent |
Removes a child component.
(Inherited from Component) |
| RemoveFromParent | (Inherited from UIControl) |
| ResetCreateTime | (Inherited from UIControl) |
| ToString |
Returns the name and type of the object as a string.
(Inherited from Component) |
| TypeSettingsIsPublic |
Checks whether the object provided as a type is public.
(Inherited from Component) |
| TypeSettingsIsPublicMember |
Checks whether the member is set up as public.
(Inherited from Component) |
| Unfocus | (Inherited from UIControl) |
Events| Name | Description | |
|---|---|---|
 | AddedToParent |
Occurs when a component is added to the parent.
(Inherited from Component) |
| AfterRenderUIWithChildren | (Inherited from UIControl) |
| BackgroundColorChanged | (Inherited from UIControl) |
| BackgroundRoundingChanged | (Inherited from UIControl) |
| BeforeRenderUIWithChildren | (Inherited from UIControl) |
| CanBeSelectedChanged | (Inherited from UIControl) |
| ClampChanged | |
| CloneEvent |
Occurs when object is cloned.
(Inherited from Component) |
| CloneSupportChanged |
Occurs after changing value of CloneSupport property.
(Inherited from Component) |
| ColorMultiplierChanged | (Inherited from UIControl) |
| ComponentAdded |
Occurs when a child component is added.
(Inherited from Component) |
| ComponentRemoved |
Occurs when a child component is removed.
(Inherited from Component) |
| ComponentsChanged |
Occurs when the set of children is changed.
(Inherited from Component) |
| DisabledInSimulation |
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) |
| DisabledInSimulationAndIsInstance |
Occurs when the object is detached from a hierarchy of the components or is disabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| DisplayInEditorChanged |
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component) |
| DisposeEvent |
Occurs when the object is disposed.
(Inherited from Component) |
| EnabledChanged |
Occurs when the Enabled property value changes.
(Inherited from Component) |
| EnabledInHierarchyChanged |
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component) |
| EnabledInSimulation |
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) |
| EnabledInSimulationAndIsInstance |
Occurs when the object is attached to a hierarchy of the components, it is enabled, which was created as an instance (is not resource). The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component) |
| FilteringChanged | |
| HorizontalAlignChanged | (Inherited from UIControl) |
| JoystickEvent | (Inherited from UIControl) |
| KeyDown | (Inherited from UIControl) |
| KeyDownBefore | (Inherited from UIControl) |
| KeyPress | (Inherited from UIControl) |
| KeyPressBefore | (Inherited from UIControl) |
| KeyUp | (Inherited from UIControl) |
| KeyUpBefore | (Inherited from UIControl) |
| LoadEvent |
Occurs during object loading.
(Inherited from Component) |
| MarginChanged | (Inherited from UIControl) |
| MetadataGetMemberBySignatureEvent |
Occurs when the object metadata member is received by name.
(Inherited from Component) |
| MetadataGetMembersEvent |
Occurs upon receipt of the object's metadata members.
(Inherited from Component) |
| MetadataGetMembersFilterEvent |
Occurs when filtering receive members of the object metadata.
(Inherited from Component) |
| MouseDoubleClick | (Inherited from UIControl) |
| MouseDoubleClickBefore | (Inherited from UIControl) |
| MouseDown | (Inherited from UIControl) |
| MouseDownBefore | (Inherited from UIControl) |
| MouseEnter | (Inherited from UIControl) |
| MouseLeave | (Inherited from UIControl) |
| MouseMove | (Inherited from UIControl) |
| MouseUp | (Inherited from UIControl) |
| MouseUpBefore | (Inherited from UIControl) |
| MouseWheel | (Inherited from UIControl) |
| MouseWheelBefore | (Inherited from UIControl) |
| NameChanged |
Occurs when component name is changed.
(Inherited from Component) |
| NetworkModeChanged | Occurs when the NetworkMode property value changes. (Inherited from Component) |
| PreloadResourcesEvent |
Occurs when preloading the resources used by the object.
(Inherited from Component) |
| ReadOnlyChanged | (Inherited from UIControl) |
| ReceiveNetworkMessageFromClient | (Inherited from Component) |
| ReceiveNetworkMessageFromServer | (Inherited from Component) |
| RemovedFromParent |
Occurs when a component is removed from the parent.
(Inherited from Component) |
| RenderUI | (Inherited from UIControl) |
| SaveEvent |
Occurs during object saving.
(Inherited from Component) |
| SaveSupportChanged |
Occurs after changing value of SaveSupport property.
(Inherited from Component) |
| ScreenLabelChanged | Occurs when the ScreenLabel property value changes. (Inherited from Component) |
| SimulationStep |
Occurs during the simulation step.
(Inherited from Component) |
| SimulationStepClient |
Occurs during the simulation step.
(Inherited from Component) |
| SizeChanged | (Inherited from UIControl) |
| SourceImageChanged | |
| SpecialInputDeviceEvent | (Inherited from UIControl) |
| StyleChanged | (Inherited from UIControl) |
| TextChanged | (Inherited from UIControl) |
| TextChanging | (Inherited from UIControl) |
| TextureCoordinatesChanged | |
| TextureCoordinatesRotationChanged | Occurs when the TextureCoordinatesRotation property value changes. |
| TopMostChanged | (Inherited from UIControl) |
| Touch | (Inherited from UIControl) |
| UpdateEvent |
Occurs during the update process of all objects.
(Inherited from Component) |
| VerticalAlignChanged | (Inherited from UIControl) |
| VisibleChanged | (Inherited from UIControl) |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also