GUIButtonModel Class |
The GUIButton class defines a button element in the GUI.
Inheritance Hierarchy
SystemObject
Livit.Learn.ModelBaseModel
Livit.Learn.ModelTriggableModel
Livit.Learn.ModelScopeableModel
Livit.Learn.ModelViewableModel
Livit.Learn.ModelStateableModel
Livit.Learn.Model.GUIGUIBaseModel
Livit.Learn.Model.GUIGUIViewBaseModel
Livit.Learn.Model.GUIGUIWidgetModel
Livit.Learn.Model.GUIGUIImageModel
Livit.Learn.Model.GUIGUILabelModel
Livit.Learn.Model.GUIGUIButtonBaseModel
Livit.Learn.Model.GUIGUIButtonModel
Livit.Learn.Model.GUIGUICheckboxModel
Livit.Learn.Model.GUIGUIViewportModel
Livit.Learn.ModelBaseModel
Livit.Learn.ModelTriggableModel
Livit.Learn.ModelScopeableModel
Livit.Learn.ModelViewableModel
Livit.Learn.ModelStateableModel
Livit.Learn.Model.GUIGUIBaseModel
Livit.Learn.Model.GUIGUIViewBaseModel
Livit.Learn.Model.GUIGUIWidgetModel
Livit.Learn.Model.GUIGUIImageModel
Livit.Learn.Model.GUIGUILabelModel
Livit.Learn.Model.GUIGUIButtonBaseModel
Livit.Learn.Model.GUIGUIButtonModel
Livit.Learn.Model.GUIGUICheckboxModel
Livit.Learn.Model.GUIGUIViewportModel
Namespace: Livit.Learn.Model.GUI
Assembly: Livit.Learn.Model (in Livit.Learn.Model.dll) Version: 0.0.0.0
SyntaxC#
[SerializableAttribute] public class GUIButtonModel : GUIButtonBaseModel
The GUIButtonModel type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GUIButtonModel | Initializes a new instance of the GUIButtonModel class |
Properties| Name | Description | |
|---|---|---|
 | AccessibilityText |
Additional text that will be read out together with the text of the button (if such)
Only in Accessibility Mode
(Inherited from GUIButtonBaseModel.) |
| Align |
Aligns the Widget in the parent GUI.
(Inherited from GUIWidgetModel.) |
| AtlasPath |
Defines the texture atlas to be applied to the GUI object.
(Inherited from GUIViewBaseModel.) |
| Attached |
Defines an attached property.
(Inherited from BaseModel.) |
| AutoResizeOffset | (Inherited from GUILabelModel.) |
| AutoResizeOffsetSerialized |
Offsets the Label content from the edges when automatically resized.
(Inherited from GUILabelModel.) |
| AutoResizeWithLabel |
Resizes the Label automatically.
(Inherited from GUILabelModel.) |
| BackgroundImageSource |
Defines the background image of the Image.
(Inherited from GUIImageModel.) |
| ClickMode |
Defines the behavior of the Button when clicked.
(Inherited from GUIButtonBaseModel.) |
| ClickTriggerNumberKey | (Inherited from GUIButtonBaseModel.) |
| Color | (Inherited from GUIWidgetModel.) |
| Command |
(Deprecated) Defines an action to be executed when the Button is clicked.
|
| CommandParameter |
Defines a parameter to for the Command.
|
| Comments |
(Development) Includes comments in the XML code.
(Inherited from BaseModel.) |
 | DataContext |
Contains a source of all bindings defined for element.
(Inherited from BaseModel.) |
| Depth |
Defines the depth of the Widget.
(Inherited from GUIWidgetModel.) |
| Description |
Displays a description of the object to the user.
(Inherited from TriggableModel.) |
| Disabled |
Defines the color of the Button when clicked by the user.
(Inherited from GUIButtonBaseModel.) |
| Effect |
Applies an effect to the Label.
(Inherited from GUILabelModel.) |
| EffectColor | (Inherited from GUILabelModel.) |
| EffectColorSerialized |
Applies a color to the Effect on the Label.
(Inherited from GUILabelModel.) |
| EmphasisDuration |
Duration of an element's emphasizing in the scene.
(Inherited from ViewableModel.) |
| ExternalXmlPath | (Inherited from BaseModel.) |
| Fields | (Inherited from ScopeableModel.) |
| FieldsSerialized | (Inherited from ScopeableModel.) |
| FontPath |
Defines the font to be used on the GUI object.
(Inherited from GUIViewBaseModel.) |
| GUITooltipId |
Specifies the GUI tooltip template used for this element.
(Inherited from GUIImageModel.) |
| GUIViewport |
Applies a Viewport to magnify the Image.
(Inherited from GUIImageModel.) |
| HashedPath |
Used by PlayHistory to store and retrieve relative coordinates of the object inside the XML tree
(Inherited from GUIButtonBaseModel.) |
| Hover |
Defines the color of the Button when the user hovers over it.
(Inherited from GUIButtonBaseModel.) |
| Id |
Defines a unique identifier for an element in the simulation.
(Inherited from BaseModel.) |
| ImageOffset | (Inherited from GUIImageModel.) |
| ImageOffsetSerialized |
Offsets the image's position from its parent element.
(Inherited from GUIImageModel.) |
| ImageSource |
Defines the Image used by the GUI object.
(Inherited from GUIViewBaseModel.) |
| InitialSize |
Defines the size in pixels of the Widget.
(Inherited from GUIWidgetModel.) |
| InitialText |
Defines the content of the Label.
(Inherited from GUILabelModel.) |
| IsClickable |
Allows the Button to be clicked on by the user.
(Inherited from GUIButtonBaseModel.) |
| IsIdAutogenerated | (Inherited from BaseModel.) |
| IsScope | (Inherited from ScopeableModel.) |
| IsVisible | (Inherited from ViewableModel.) |
| KeepAspectRatio |
Maintains the Label's aspect ratio when resized.
(Inherited from GUILabelModel.) |
| LabelPaddingX |
Defines the Padding of the text label inside the button towards its sides
(Inherited from GUIButtonBaseModel.) |
| MaxLineCount |
Defines the maximum number of lines that can be displayed on the Label.
(Inherited from GUILabelModel.) |
| MessageHandlers | (Inherited from ScopeableModel.) |
| MessageHandlersSerialized | (Inherited from ScopeableModel.) |
| Name |
(Obsolete) Refers to the GUI object.
(Inherited from GUIViewBaseModel.) |
| NavigateTo |
Defines a GUIScreen to navigate to when the Button is clicked.
|
| Normal |
Defines the default color of the Button.
(Inherited from GUIButtonBaseModel.) |
| OutlineAtlas |
If not empty, the atlas used is the one stated here, otherwise using the same atlas as the button itself.
(Inherited from GUIButtonBaseModel.) |
| OutlineDisabled |
Defines the disabled color of the outline
(Inherited from GUIButtonBaseModel.) |
| OutlineHover |
Defines the hover color of the outline
(Inherited from GUIButtonBaseModel.) |
| OutlineImage |
If not empty, the button will have an Outline using the image stated here as base.
(Inherited from GUIButtonBaseModel.) |
| OutlineNormal |
Defines the normal color of the outline
(Inherited from GUIButtonBaseModel.) |
| OutlinePressed |
Defines the pressed color of the outline
(Inherited from GUIButtonBaseModel.) |
| OutlineThickness |
Defines the thickness of the outline
(Inherited from GUIButtonBaseModel.) |
| OutlineVisibilityOption |
Boolean flag to enable/disable outline
(Inherited from GUIButtonBaseModel.) |
| Overflow |
Determines the Label's behavior if the Text is larger than the defined size.
(Inherited from GUILabelModel.) |
| Pivot |
Aligns the GUI object to its parent.
(Inherited from GUIViewBaseModel.) |
| Position |
Defines the position of the GUI object relative to its parent.
(Inherited from GUIViewBaseModel.) |
| Pressed |
Defines the color of the Button when clicked by the user.
(Inherited from GUIButtonBaseModel.) |
| RapidClickDelay |
Defines a minimum interval before another click will be allowed on the Button.
(Inherited from GUIButtonBaseModel.) |
| ResizeMode |
Defines how the Image will be resized.
(Inherited from GUIImageModel.) |
| Rotation |
Defines the Z-rotation of the GUI object relative to its parent (defaults to 0).
(Inherited from GUIViewBaseModel.) |
| Shader |
Applies a shader effect to the Image.
(Inherited from GUIImageModel.) |
| Sound |
Plays a sound when the Button is clicked.
(Inherited from GUIButtonBaseModel.) |
| Source |
Defines the content source of the GUI object.
(Inherited from GUIViewBaseModel.) |
| Spacing | (Inherited from GUILabelModel.) |
| SpacingSerialized |
Defines the distance between characters in the Label.
(Inherited from GUILabelModel.) |
| StateGroups |
Defines the possible StateGroup for this element.
(Inherited from StateableModel.) |
| StateGroupsSerialized | (Inherited from StateableModel.) |
| StyleId |
Defines the style identifier of the GUI object.
(Inherited from GUIViewBaseModel.) |
| Tags | (Inherited from ViewableModel.) |
| TemplateVersionId |
Contains a id of source template.
(Inherited from BaseModel.) |
| TextColor |
Defines the color of the text inside the Button.
(Inherited from GUIButtonBaseModel.) |
| TextOffset | (Inherited from GUILabelModel.) |
| TextOffsetSerialized |
Offsets the text from the Label edge.
(Inherited from GUILabelModel.) |
| TextSize |
Defines the size of the Text.
(Inherited from GUILabelModel.) |
| TextWidth |
Defines the width of the text in the Button.
(Inherited from GUIButtonBaseModel.) |
| TileMode |
Defines how the Image will be loaded in the GUI.
(Inherited from GUIImageModel.) |
| TileSize | (Inherited from GUIImageModel.) |
| TileSizeSerialized |
Defines the size of the tiling used to display this Image.
(Inherited from GUIImageModel.) |
| Title |
Defines a title for the object.
(Inherited from TriggableModel.) |
| Tooltip |
Sets the tooltip displayed when the element is hovered over.
(Inherited from GUIImageModel.) |
| Triggers | (Inherited from TriggableModel.) |
| TriggersSerialized |
Lists the available Triggers for
this object.
(Inherited from TriggableModel.) |
| Use2DTooltip | Obsolete.
Specifies whether usual 3D tooltip should be changed to legacy 2D one.
(Inherited from GUIImageModel.) |
| ViewportId |
Offsets the Image relative to the target Viewport.
(Inherited from GUIImageModel.) |
| WasShown |
(Internal use only) Returns true if the object has been shown in the simulation.
(Inherited from ViewableModel.) |
| XmlComments |
(Development) Used as temporary storage for XML comments (like ) to keep them.
(Inherited from BaseModel.) |
Methods| Name | Description | |
|---|---|---|
| DeepCopy |
Creates an in-memory clone of this object using a BinaryFormatter to ensure all child properties are copied as well.
(Inherited from BaseModel.) |
| ShallowCopy | (Inherited from BaseModel.) |
| ShouldSerializeStateGroups | (Inherited from StateableModel.) |
| ShouldSerializeTriggers | (Inherited from TriggableModel.) |
| ToString |
Returns a string that represents the current object.
(Inherited from BaseModel.) |
| UpdateModels |
This method will update this model and all its child models.
(Inherited from BaseModel.) |
See Also