Show / Hide Table of Contents

Class NSMDOListItem

Carrier object for MDOListItem.

Syntax

Constructors

NSMDOListItem()

Initializes a new instance of the NSMDOListItem class.

Declaration
NSMDOListItem

Methods

GetChildItems()

Carrier object for MDOListItem.

Declaration
NSMDOListItem[] GetChildItems()
Returns
Type Description
NSMDOListItem[]

The child items of the NSMDOListItem.

Examples
NSMDOListItem thing;
NSMDOListItem[] childItems = thing.GetChildItems();

GetColorBlock()

Carrier object for MDOListItem.

Declaration
Integer GetColorBlock()
Returns
Type Description
Integer

The color indicator of the ListItem color block.

Examples
NSMDOListItem thing;
Integer colorBlock = thing.GetColorBlock();

GetDeleted()

Carrier object for MDOListItem.

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

The deleted status of the ListItem.

Examples
NSMDOListItem thing;
Bool deleted = thing.GetDeleted();

GetExtraInfo()

Carrier object for MDOListItem.

Declaration
String GetExtraInfo()
Returns
Type Description
String

Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field.

Examples
NSMDOListItem thing;
String extraInfo = thing.GetExtraInfo();

GetFullName()

Carrier object for MDOListItem.

Declaration
String GetFullName()
Returns
Type Description
String

The name of the ListItem in its context.

Examples
NSMDOListItem thing;
String fullName = thing.GetFullName();

GetIconHint()

Carrier object for MDOListItem.

Declaration
String GetIconHint()
Returns
Type Description
String

The Icon hint of the ListItem. Custom field.

Examples
NSMDOListItem thing;
String iconHint = thing.GetIconHint();

GetId()

Carrier object for MDOListItem.

Declaration
Integer GetId()
Returns
Type Description
Integer

The ID of the ListItem.

Examples
NSMDOListItem thing;
Integer id = thing.GetId();

GetName()

Carrier object for MDOListItem.

Declaration
String GetName()
Returns
Type Description
String

The name of the ListItem.

Examples
NSMDOListItem thing;
String name = thing.GetName();

GetRank()

Carrier object for MDOListItem.

Declaration
Integer GetRank()
Returns
Type Description
Integer

The rank of the ListItem.

Examples
NSMDOListItem thing;
Integer rank = thing.GetRank();

GetStyleHint()

Carrier object for MDOListItem.

Declaration
String GetStyleHint()
Returns
Type Description
String

Style hint indicating, information such as background color etc. Custom field.

Examples
NSMDOListItem thing;
String styleHint = thing.GetStyleHint();

GetToolTip()

Carrier object for MDOListItem.

Declaration
String GetToolTip()
Returns
Type Description
String

The tooltip of the ListItem.

Examples
NSMDOListItem thing;
String toolTip = thing.GetToolTip();

GetType()

Carrier object for MDOListItem.

Declaration
String GetType()
Returns
Type Description
String

The type of the ListItem. Custom field.

Examples
NSMDOListItem thing;
String type = thing.GetType();

SetChildItems(NSMDOListItem[])

Carrier object for MDOListItem.

Declaration
Void SetChildItems(NSMDOListItem[] childItems)
Parameters
Type Name Description
NSMDOListItem[] childItems

The child items of the NSMDOListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
NSMDOListItem[] childItems;
thing.SetChildItems(childItems);

SetColorBlock(Integer)

Carrier object for MDOListItem.

Declaration
Void SetColorBlock(Integer colorBlock)
Parameters
Type Name Description
Integer colorBlock

The color indicator of the ListItem color block.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
Integer colorBlock;
thing.SetColorBlock(colorBlock);

SetDeleted(Bool)

Carrier object for MDOListItem.

Declaration
Void SetDeleted(Bool deleted)
Parameters
Type Name Description
Bool deleted

The deleted status of the ListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
Bool deleted;
thing.SetDeleted(deleted);

SetExtraInfo(String)

Carrier object for MDOListItem.

Declaration
Void SetExtraInfo(String extraInfo)
Parameters
Type Name Description
String extraInfo

Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);

SetFullName(String)

Carrier object for MDOListItem.

Declaration
Void SetFullName(String fullName)
Parameters
Type Name Description
String fullName

The name of the ListItem in its context.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String fullName;
thing.SetFullName(fullName);

SetIconHint(String)

Carrier object for MDOListItem.

Declaration
Void SetIconHint(String iconHint)
Parameters
Type Name Description
String iconHint

The Icon hint of the ListItem. Custom field.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String iconHint;
thing.SetIconHint(iconHint);

SetId(Integer)

Carrier object for MDOListItem.

Declaration
Void SetId(Integer id)
Parameters
Type Name Description
Integer id

The ID of the ListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
Integer id;
thing.SetId(id);

SetName(String)

Carrier object for MDOListItem.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

The name of the ListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String name;
thing.SetName(name);

SetRank(Integer)

Carrier object for MDOListItem.

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

The rank of the ListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
Integer rank;
thing.SetRank(rank);

SetStyleHint(String)

Carrier object for MDOListItem.

Declaration
Void SetStyleHint(String styleHint)
Parameters
Type Name Description
String styleHint

Style hint indicating, information such as background color etc. Custom field.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String styleHint;
thing.SetStyleHint(styleHint);

SetToolTip(String)

Carrier object for MDOListItem.

Declaration
Void SetToolTip(String toolTip)
Parameters
Type Name Description
String toolTip

The tooltip of the ListItem.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String toolTip;
thing.SetToolTip(toolTip);

SetType(String)

Carrier object for MDOListItem.

Declaration
Void SetType(String type)
Parameters
Type Name Description
String type

The type of the ListItem. Custom field.

Returns
Type Description
Void
Examples
NSMDOListItem thing;
String type;
thing.SetType(type);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top