pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::IFMItem Class Reference

Folder Manager Item. More...

Inheritance diagram for X3g::Plugin::IFMItem:
Inheritance graph
[legend]

Public Member Functions

void SetReferenceNumber (System::String^ pNumber)
 Assignes a new reference number to the item. More...
 
IFMItemGetParent ()
 Returns the current parent of the item. More...
 
ReadOnlyCollection< IFMItem^ >^ GetChildren ()
 Returns the current children of the item. More...
 

Properties

System::String^  Id [get]
 The item id. More...
 
System::String^  Label [get]
 The label of the item. More...
 
System::String^  Description [get]
 The description of the item. More...
 
System::String^  ReferenceNumber [get]
 The item's reference number. More...
 

Detailed Description

Folder Manager Item.

Member Function Documentation

ReadOnlyCollection< X3g::Plugin::IFMItem^ > X3g::Plugin::IFMItem::GetChildren ( )

Returns the current children of the item.

X3g::Plugin::IFMItem X3g::Plugin::IFMItem::GetParent ( )

Returns the current parent of the item.

void X3g::Plugin::IFMItem::SetReferenceNumber ( System::String^  pNumber)

Assignes a new reference number to the item.

Property Documentation

System:: String^ X3g::Plugin::IFMItem::Description
get

The description of the item.

For items supporting long text (currently sets and articles) this is the long text, otherwise the label is used.

System:: String^ X3g::Plugin::IFMItem::Id
get

The item id.

If the item is an article the id relates to IArticleEntity::Id. If the item is a folder the id relates to IArticleEntityInfo::FolderId.

System:: String^ X3g::Plugin::IFMItem::Label
get

The label of the item.

For articles, if the short text of the article is not empty, it is used as label, otherwise the article number is used.

System:: String^ X3g::Plugin::IFMItem::ReferenceNumber
get

The item's reference number.

If the item is an article the number relates to IArticleEntityInfo::ReferenceNumber.