Component:DesktopDisplayLayout: Difference between revisions

Revision as of 21:08, 15 January 2025

Component image

**Desktop Display Layout** component as seen in the Scene Inspector

The DesktopDisplayLayout component displays a list of display selection buttons for a user's monitor settup. Used in the dash and only works in the dash world.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`User`	direct UserRef	The user to get displays for.
`DisplayTemplate`	Slot	the template to use when generating display selection buttons.
`ItemGenerated`	delegate of identity DisplayItemHandler	usually the OnDisplayItemGenerated() sync delegate from DesktopControlDialog.

DisplayItemHandler

A Sync delegate of type Delegate<Display display, Slot itemRoot>

Examples

Used in the dash desktop tab.

@@ Line 3: / Line 3: @@
 |Name=Desktop Display Layout
 }}
-{{stub}}
+The '''DesktopDisplayLayout''' component displays a list of display selection buttons for a user's monitor settup. Used in the dash and only works in the dash world.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|User|{{RootFieldType|UserRef}}|TypeAdv0=true|
+|User|{{RootFieldType|UserRef}}|TypeAdv0=true| The user to get displays for.
-|DisplayTemplate|Slot|
+|DisplayTemplate|Slot| the template to use when generating display selection buttons.
-|ItemGenerated|{{RootFieldType|SyncDelegate`1|[[#DisplayItemHandler|DisplayItemHandler]]}}|TypeAdv2=true|
+|ItemGenerated|{{RootFieldType|SyncDelegate`1|[[#DisplayItemHandler|DisplayItemHandler]]}}|TypeAdv2=true| usually the OnDisplayItemGenerated() sync delegate from [[Component:DesktopControlDialog#Sync Delegates|DesktopControlDialog]].
 }}
-== Behavior ==
+== DisplayItemHandler ==
+A Sync delegate of type [[Type:Delegate|Delegate]]&lt;[[Type:Display|Display]] display, [[Type:Slot|Slot]] itemRoot&gt;
 == Examples ==
+Used in the dash desktop tab.
 == See Also ==
@@ Line 21: / Line 23: @@
 [[Category:Components{{#translation:}}|Desktop Display Layout]]
 [[Category:Components With Nested Types{{#translation:}}|Desktop Display Layout]]
-[[Category:ComponentStubs]]