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::IFolderManager Class Reference

Folder Manager. More...

Public Member Functions

IFMItemGetItem (System::String^ pId)
 Get an Item by id. More...
 
IFMFolderItemCreateFolder (IFMFolderItem^ pFather)
 Create a new folder, which will be the last child of it's father. More...
 
bool DeleteFolder (IFMFolderItem^ pFolder)
 Delete a given folder. More...
 
IFMSetArticleItemCreateSetArticle (IFMFolderItem^ pFather)
 Create a new set article, which will be the last child of it's father. More...
 
bool DeleteSetArticle (IFMSetArticleItem^ pSetArticle)
 Delete a given folder. More...
 
IFMSetArticleItemConvertToSetArticle (IFMFolderItem^ pFather)
 Convert the given folder into a set article. More...
 
IFMFolderItemConvertToFolder (IFMSetArticleItem^ pFather)
 Convert the given set article into a folder. More...
 
bool MoveItems (ReadOnlyCollection< IFMItem^ >^pItems, IFMItem^ pFather, IFMItem^ pPrev)
 Move items. More...
 
bool StartTransaction ()
 Start Transaction. More...
 
bool FinishTransaction ()
 Finish Transaction. More...
 

Properties

IFMFolderItem^  CurrentFolder [get, set]
 The folder into which new articles will be inserted. More...
 
IFMFolderItem^  RootFolder [get]
 The root folder. More...
 

Detailed Description

Folder Manager.

Member Function Documentation

X3g::Plugin::IFMFolderItem X3g::Plugin::IFolderManager::ConvertToFolder ( IFMSetArticleItem pFather)

Convert the given set article into a folder.

X3g::Plugin::IFMSetArticleItem X3g::Plugin::IFolderManager::ConvertToSetArticle ( IFMFolderItem pFather)

Convert the given folder into a set article.

Converting a folder which contains sub-folders or set-articles is not allowed.

X3g::Plugin::IFMFolderItem X3g::Plugin::IFolderManager::CreateFolder ( IFMFolderItem pFather)

Create a new folder, which will be the last child of it's father.

X3g::Plugin::IFMSetArticleItem X3g::Plugin::IFolderManager::CreateSetArticle ( IFMFolderItem pFather)

Create a new set article, which will be the last child of it's father.

bool X3g::Plugin::IFolderManager::DeleteFolder ( IFMFolderItem pFolder)

Delete a given folder.

The folder and it's sub-folders must not contain articles, otherwise the folder can't be deleted. The function returns true if the folder was deleted.

bool X3g::Plugin::IFolderManager::DeleteSetArticle ( IFMSetArticleItem pSetArticle)

Delete a given folder.

The set and it's sub-folders must not contain articles, otherwise the set can't be deleted. The function returns true if the set was deleted.

bool X3g::Plugin::IFolderManager::FinishTransaction ( )

Finish Transaction.

This method finishes the transaction started before with StartTransaction(). It carries out any operation whis was deferred since the call to StartTransaction()

X3g::Plugin::IFMItem X3g::Plugin::IFolderManager::GetItem ( System::String^  pId)

Get an Item by id.

Parameters
pIdThe id of the item. Relates to IFMItem::Id.
bool X3g::Plugin::IFolderManager::MoveItems ( ReadOnlyCollection< IFMItem^ >^  pItems,
IFMItem pFather,
IFMItem pPrev 
)

Move items.

Move a set of Items either from one folder/set to another or insided the folder/set. Moving a folder/set into itself or one of it's sub-folders is not allowed. If items are moved inside the same folder/set, the list must be consecutive. The function returns true if the items could be moved.

Parameters
pItemsThe items to move.
pFatherThe new father (Folder or SetArticle).
pPrevThe new previous sibling. NULL means to insert at the first position in the folder/set.
bool X3g::Plugin::IFolderManager::StartTransaction ( )

Start Transaction.

This method starts an transaction. Updates to the CAD system (including) display are deferred until the transaction is finished.

Property Documentation

IFMFolderItem^ X3g::Plugin::IFolderManager::CurrentFolder
getset

The folder into which new articles will be inserted.

IFMFolderItem^ X3g::Plugin::IFolderManager::RootFolder
get

The root folder.