Interface: TextButton
A simple button type that contains a label
Properties
| Name | Type | Description |
activationenabled | boolean | No description provided. |
actuallayoutheight | number | No description provided. |
actuallayoutwidth | number | No description provided. |
actualuiscale_x | number | No description provided. |
actualuiscale_y | number | No description provided. |
actualxoffset | number | No description provided. |
actualyoffset | number | No description provided. |
checked | boolean | No description provided. |
contentheight | number | No description provided. |
contentwidth | number | No description provided. |
defaultfocus | string | No description provided. |
desiredlayoutheight | number | No description provided. |
desiredlayoutwidth | number | No description provided. |
enabled | boolean | No description provided. |
hittest | boolean | No description provided. |
hittestchildren | boolean | No description provided. |
id | string | No description provided. |
inputnamespace | string | No description provided. |
layoutfile | string | No description provided. |
paneltype | TextButton | No description provided. |
rememberchildfocus | boolean | No description provided. |
scrolloffset_x | number | No description provided. |
scrolloffset_y | number | No description provided. |
selectionpos_x | number | No description provided. |
selectionpos_y | number | No description provided. |
style | Style | No description provided. |
tabindex | number | No description provided. |
text | string | No description provided. |
visible | boolean | No description provided. |
Functions
AcceptsFocus
TextButton.AcceptsFocus(): boolean
No description provided.
AcceptsInput
TextButton.AcceptsInput(): boolean
No description provided.
AddClass
TextButton.AddClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ApplyStyles
TextButton.ApplyStyles(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
BAscendantHasClass
TextButton.BAscendantHasClass(arg0: string): boolean
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
CanSeeInParentScroll
TextButton.CanSeeInParentScroll(): boolean
No description provided.
Children
TextButton.Children(): GenericPanel[]
No description provided.
ClearPanelEvent
TextButton.ClearPanelEvent(event: string): void
No description provided.
Parameter
| Name | Type | Description |
event | string | No description provided. |
ClearPropertyFromCode
TextButton.ClearPropertyFromCode(arg0: unknown): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | unknown | No description provided. |
CreateChildren
TextButton.CreateChildren(elements: string): boolean
No description provided.
Parameter
| Name | Type | Description |
elements | string | No description provided. |
CreateCopyOfCSSKeyframes
TextButton.CreateCopyOfCSSKeyframes(animation: string): unknown
No description provided.
Parameter
| Name | Type | Description |
animation | string | No description provided. |
Data
TextButton.Data(...args: any[]): void
No description provided.
Parameter
| Name | Type | Description |
...args | any[] | No description provided. |
DeleteAsync
TextButton.DeleteAsync(delay: number): void
No description provided.
Parameter
| Name | Type | Description |
delay | number | No description provided. |
DeleteKeyframes
TextButton.DeleteKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
FindChild
TextButton.FindChild(id: string): T
Searches this element's direct children and returns a child with the specified id.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildInLayoutFile
TextButton.FindChildInLayoutFile(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildrenWithClassTraverse
TextButton.FindChildrenWithClassTraverse(classname: string): T[]
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
FindChildTraverse
TextButton.FindChildTraverse(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
GetAttributeInt
TextButton.GetAttributeInt(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetAttributeString
TextButton.GetAttributeString(attribute: string, fallback: string): string
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | string | No description provided. |
GetAttributeUInt32
TextButton.GetAttributeUInt32(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetChild
TextButton.GetChild(index: number): T
No description provided.
Parameter
| Name | Type | Description |
index | number | No description provided. |
GetChildCount
TextButton.GetChildCount(): number
No description provided.
GetChildIndex
TextButton.GetChildIndex(child: GenericPanel): number
No description provided.
Parameter
| Name | Type | Description |
child | GenericPanel | No description provided. |
GetFirstChild
TextButton.GetFirstChild(): T
No description provided.
GetLastChild
TextButton.GetLastChild(): T
No description provided.
GetLayoutFileDefine
TextButton.GetLayoutFileDefine(def: string): unknown
No description provided.
Parameter
| Name | Type | Description |
def | string | No description provided. |
GetParent
TextButton.GetParent(): T
No description provided.
GetPositionWithinWindow
TextButton.GetPositionWithinWindow(): unknown
No description provided.
HasClass
TextButton.HasClass(classname: string): boolean
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
HasDescendantKeyFocus
TextButton.HasDescendantKeyFocus(): boolean
No description provided.
HasHoverStyle
TextButton.HasHoverStyle(): boolean
No description provided.
HasKeyFocus
TextButton.HasKeyFocus(): boolean
No description provided.
IsDraggable
TextButton.IsDraggable(): boolean
No description provided.
IsReadyForDisplay
TextButton.IsReadyForDisplay(): boolean
No description provided.
IsSelected
TextButton.IsSelected(): boolean
No description provided.
IsSizeValid
TextButton.IsSizeValid(): boolean
No description provided.
IsTransparent
TextButton.IsTransparent(): boolean
No description provided.
IsValid
TextButton.IsValid(): boolean
Check if this panel is still valid
LoadLayout
TextButton.LoadLayout(url: string, override: boolean, partial: boolean): boolean
No description provided.
Parameters
| Name | Type | Description |
url | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutAsync
TextButton.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
url | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutFromString
TextButton.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
layout | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutFromStringAsync
TextButton.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void
No description provided.
Parameters
| Name | Type | Description |
layout | string | No description provided. |
override | boolean | No description provided. |
partial | boolean | No description provided. |
LoadLayoutSnippet
TextButton.LoadLayoutSnippet(snippet: string): boolean
No description provided.
Parameter
| Name | Type | Description |
snippet | string | No description provided. |
MoveChildAfter
TextButton.MoveChildAfter(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
MoveChildBefore
TextButton.MoveChildBefore(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
RegisterForReadyEvents
TextButton.RegisterForReadyEvents(enable: boolean): void
Registers this panel to receive ready/unready events.
Parameter
| Name | Type | Description |
enable | boolean | Should this panel receive ready/unready events? |
RemoveAndDeleteChildren
TextButton.RemoveAndDeleteChildren(): void
No description provided.
RemoveClass
TextButton.RemoveClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ScrollParentToFitWhenFocused
TextButton.ScrollParentToFitWhenFocused(): boolean
No description provided.
ScrollParentToMakePanelFit
TextButton.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | boolean | No description provided. |
ScrollToBottom
TextButton.ScrollToBottom(): void
No description provided.
ScrollToFitRegion
TextButton.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | number | No description provided. |
arg2 | number | No description provided. |
arg3 | number | No description provided. |
arg4 | unknown | No description provided. |
arg5 | boolean | No description provided. |
arg6 | boolean | No description provided. |
ScrollToLeftEdge
TextButton.ScrollToLeftEdge(): void
No description provided.
ScrollToRightEdge
TextButton.ScrollToRightEdge(): void
No description provided.
ScrollToTop
TextButton.ScrollToTop(): void
No description provided.
SetAcceptsFocus
TextButton.SetAcceptsFocus(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetAttributeInt
TextButton.SetAttributeInt(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetAttributeString
TextButton.SetAttributeString(attribute: string, value: string): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | string | No description provided. |
SetAttributeUInt32
TextButton.SetAttributeUInt32(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetDialogVariable
TextButton.SetDialogVariable(arg0: string, arg1: string): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | string | No description provided. |
SetDialogVariableFloat
TextButton.SetDialogVariableFloat(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableInt
TextButton.SetDialogVariableInt(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableTime
TextButton.SetDialogVariableTime(arg0: string, arg1: string | number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | string | number | No description provided. |
SetDisableFocusOnMouseDown
TextButton.SetDisableFocusOnMouseDown(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetDraggable
TextButton.SetDraggable(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetFocus
TextButton.SetFocus(focus: boolean): boolean
No description provided.
Parameter
| Name | Type | Description |
focus | boolean | No description provided. |
SetHasClass
TextButton.SetHasClass(classname: string, hasclass: boolean): void
No description provided.
Parameters
| Name | Type | Description |
classname | string | No description provided. |
hasclass | boolean | No description provided. |
SetInputNamespace
TextButton.SetInputNamespace(arg0: string): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
SetPanelEvent
TextButton.SetPanelEvent(event: string, callback: Func<any[], void>): void
Sets an event trigger for this panel.
Example
latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));
Parameters
| Name | Type | Description |
event | string | No description provided. |
callback | Func<any[], void> | No description provided. |
See also
SetParent
TextButton.SetParent(parent: GenericPanel): void
No description provided.
Parameter
| Name | Type | Description |
parent | GenericPanel | No description provided. |
SetReadyForDisplay
TextButton.SetReadyForDisplay(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetScrollParentToFitWhenFocused
TextButton.SetScrollParentToFitWhenFocused(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetTopOfInputContext
TextButton.SetTopOfInputContext(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SortChildrenOnAttribute
TextButton.SortChildrenOnAttribute(attribute: string, ascending: boolean): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
ascending | boolean | No description provided. |
SwitchClass
TextButton.SwitchClass(oldclass: string, newclass: string): void
No description provided.
Parameters
| Name | Type | Description |
oldclass | string | No description provided. |
newclass | string | No description provided. |
ToggleClass
TextButton.ToggleClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
TriggerClass
TextButton.TriggerClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
UpdateCurrentAnimationKeyframes
TextButton.UpdateCurrentAnimationKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
UpdateFocusInContext
TextButton.UpdateFocusInContext(): boolean
No description provided.