Interface: RadioButton

Interface describing base panel properties that all other panels extend.

Properties

NameTypeDescription
activationenabledbooleanNo description provided.
actuallayoutheightnumberNo description provided.
actuallayoutwidthnumberNo description provided.
actualuiscale_xnumberNo description provided.
actualuiscale_ynumberNo description provided.
actualxoffsetnumberNo description provided.
actualyoffsetnumberNo description provided.
checkedbooleanNo description provided.
contentheightnumberNo description provided.
contentwidthnumberNo description provided.
defaultfocusstringNo description provided.
desiredlayoutheightnumberNo description provided.
desiredlayoutwidthnumberNo description provided.
enabledbooleanNo description provided.
groupstringNo description provided.
hittestbooleanNo description provided.
hittestchildrenbooleanNo description provided.
idstringNo description provided.
inputnamespacestringNo description provided.
layoutfilestringNo description provided.
paneltypeRadioButtonNo description provided.
rememberchildfocusbooleanNo description provided.
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
styleStyle No description provided.
tabindexnumberNo description provided.
visiblebooleanNo description provided.

Functions

AcceptsFocus

RadioButton.AcceptsFocus(): boolean

No description provided.

AcceptsInput

RadioButton.AcceptsInput(): boolean

No description provided.

AddClass

RadioButton.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

RadioButton.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

RadioButton.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

RadioButton.CanSeeInParentScroll(): boolean

No description provided.

Children

RadioButton.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

RadioButton.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

RadioButton.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

RadioButton.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

RadioButton.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

RadioButton.Data(...args: any[]): void

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

RadioButton.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

RadioButton.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

RadioButton.FindChild(id: string): T

Searches this element's direct children and returns a child with the specified id.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

RadioButton.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

RadioButton.FindChildrenWithClassTraverse(classname: string): T[]

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

RadioButton.FindChildTraverse(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

RadioButton.GetAttributeInt(attribute: string, fallback: number): number

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

RadioButton.GetAttributeString(attribute: string, fallback: string): string

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

RadioButton.GetAttributeUInt32(attribute: string, fallback: number): number

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

RadioButton.GetChild(index: number): T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

RadioButton.GetChildCount(): number

No description provided.

GetChildIndex

RadioButton.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childGenericPanel No description provided.

GetFirstChild

RadioButton.GetFirstChild(): T

No description provided.

GetLastChild

RadioButton.GetLastChild(): T

No description provided.

GetLayoutFileDefine

RadioButton.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

RadioButton.GetParent(): T

No description provided.

GetPositionWithinWindow

RadioButton.GetPositionWithinWindow(): unknown

No description provided.

GetSelectedButton

RadioButton.GetSelectedButton(): T

No description provided.

HasClass

RadioButton.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

RadioButton.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

RadioButton.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

RadioButton.HasKeyFocus(): boolean

No description provided.

IsDraggable

RadioButton.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

RadioButton.IsReadyForDisplay(): boolean

No description provided.

IsSelected

RadioButton.IsSelected(): boolean

No description provided.

IsSizeValid

RadioButton.IsSizeValid(): boolean

No description provided.

IsTransparent

RadioButton.IsTransparent(): boolean

No description provided.

IsValid

RadioButton.IsValid(): boolean

Check if this panel is still valid

LoadLayout

RadioButton.LoadLayout(url: string, override: boolean, partial: boolean): boolean

No description provided.

Parameters

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutAsync

RadioButton.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromString

RadioButton.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromStringAsync

RadioButton.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutSnippet

RadioButton.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

RadioButton.MoveChildAfter(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

RadioButton.MoveChildBefore(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

RadioButton.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

RadioButton.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

RadioButton.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

RadioButton.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

RadioButton.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

RadioButton.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

RadioButton.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1numberNo description provided.
arg2numberNo description provided.
arg3numberNo description provided.
arg4unknownNo description provided.
arg5booleanNo description provided.
arg6booleanNo description provided.

ScrollToLeftEdge

RadioButton.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

RadioButton.ScrollToRightEdge(): void

No description provided.

ScrollToTop

RadioButton.ScrollToTop(): void

No description provided.

SetAcceptsFocus

RadioButton.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

RadioButton.SetAttributeInt(attribute: string, value: number): void

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

RadioButton.SetAttributeString(attribute: string, value: string): void

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

RadioButton.SetAttributeUInt32(attribute: string, value: number): void

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

RadioButton.SetDialogVariable(arg0: string, arg1: string): void

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1stringNo description provided.

SetDialogVariableFloat

RadioButton.SetDialogVariableFloat(arg0: string, arg1: number): void

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableInt

RadioButton.SetDialogVariableInt(arg0: string, arg1: number): void

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableTime

RadioButton.SetDialogVariableTime(arg0: string, arg1: string | number): void

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1string | numberNo description provided.

SetDisableFocusOnMouseDown

RadioButton.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

RadioButton.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

RadioButton.SetFocus(focus: boolean): boolean

No description provided.

Parameter

NameTypeDescription
focusbooleanNo description provided.

SetHasClass

RadioButton.SetHasClass(classname: string, hasclass: boolean): void

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

RadioButton.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

RadioButton.SetPanelEvent(event: string, callback: Func<any[], void>): void

Sets an event trigger for this panel.

Example

latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));

Parameters

NameTypeDescription
eventstringNo description provided.
callbackFunc<any[], void>No description provided.

See also

SetParent

RadioButton.SetParent(parent: GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentGenericPanel No description provided.

SetReadyForDisplay

RadioButton.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

RadioButton.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetSelected

RadioButton.SetSelected(selected: boolean): void

No description provided.

Parameter

NameTypeDescription
selectedbooleanNo description provided.

SetTopOfInputContext

RadioButton.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

RadioButton.SortChildrenOnAttribute(attribute: string, ascending: boolean): void

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

RadioButton.SwitchClass(oldclass: string, newclass: string): void

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

RadioButton.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

RadioButton.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

RadioButton.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

RadioButton.UpdateFocusInContext(): boolean

No description provided.