The ApiExplorerRow class represents an item displayed in the Content Manager Explorer user interface object. It is primarily used in the SDK to represent a user-defined starting point in the Explorer window. More...

Public Member Functions
	ExplorerRow ()
	Constructs a default ExplorerRow More...

	ExplorerRow (ExplorerCategory category)
	Constructs an ExplorerRow representing a top level category row More...

	ExplorerRow (BaseObjectTypes favoriteType)
	Construct an ExplorerRow representing the favorites node for a particular object type More...

	ExplorerRow (TrayType tray)
	Construct an ExplorerRow representing the tray node for a particular tray type More...

	ExplorerRow (TrimMainObject navObject)
	Construct an ExplorerRow representing a navigation object available in the Explorer hierarchy More...

TrimMainObject	getObject (Database db)
	Gets the navigation object for this row - only relevant for rows of type ExplorerRowType.Object More...

Properties
ExplorerRowType	RowType `[get]`
	Gets an enumerated ExplorerRowType value indicating what type of explorer row this is More...

ExplorerCategory	Category `[get]`
	Gets the category type of this row - only relevant for rows of type ExplorerRowType.Category More...

BaseObjectTypes	FavoriteType `[get]`
	Gets the favorite type of this row - only relevant for rows of type ExplorerRowType.FavoriteType More...

TrayType	TrayType `[get]`
	Gets the favorite type of this row - only relevant for rows of type ExplorerRowType.TrayType More...

Detailed Description

The ApiExplorerRow class represents an item displayed in the Content Manager Explorer user interface object. It is primarily used in the SDK to represent a user-defined starting point in the Explorer window.

Constructor & Destructor Documentation

◆ ExplorerRow() [1/5]

TRIM.SDK.ExplorerRow.ExplorerRow ( )

Constructs a default ExplorerRow

◆ ExplorerRow() [2/5]

TRIM.SDK.ExplorerRow.ExplorerRow ( ExplorerCategory category )

Constructs an ExplorerRow representing a top level category row

◆ ExplorerRow() [3/5]

TRIM.SDK.ExplorerRow.ExplorerRow ( BaseObjectTypes favoriteType )

Construct an ExplorerRow representing the favorites node for a particular object type

◆ ExplorerRow() [4/5]

TRIM.SDK.ExplorerRow.ExplorerRow ( TrayType tray )

Construct an ExplorerRow representing the tray node for a particular tray type

◆ ExplorerRow() [5/5]

TRIM.SDK.ExplorerRow.ExplorerRow ( TrimMainObject navObject )

Construct an ExplorerRow representing a navigation object available in the Explorer hierarchy

Member Function Documentation

◆ getObject()

TrimMainObject TRIM.SDK.ExplorerRow.getObject ( Database db )

Gets the navigation object for this row - only relevant for rows of type ExplorerRowType.Object

Property Documentation

◆ Category

ExplorerCategory TRIM.SDK.ExplorerRow.Category

get

Gets the category type of this row - only relevant for rows of type ExplorerRowType.Category

◆ FavoriteType

BaseObjectTypes TRIM.SDK.ExplorerRow.FavoriteType

get

Gets the favorite type of this row - only relevant for rows of type ExplorerRowType.FavoriteType

◆ RowType

ExplorerRowType TRIM.SDK.ExplorerRow.RowType

get

Gets an enumerated ExplorerRowType value indicating what type of explorer row this is

◆ TrayType

TrayType TRIM.SDK.ExplorerRow.TrayType

get

Gets the favorite type of this row - only relevant for rows of type ExplorerRowType.TrayType

Public Member Functions

Properties