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

OFML product catalog. More...

Public Member Functions

IList< CatalogItem^ >^ GetAllItems ()
 Returns all items from the catalog. More...
 

Static Public Member Functions

static IList< Catalog^ >^ GetAll ()
 Returns all catalogs from all registered packages. More...
 
static CatalogGet (Package^ pPackage)
 Returns catalog from given package. More...
 

Properties

Articles::Package^  Package [get]
 Package which contains the catalog. More...
 
CatalogItem^  RootItem [get]
 Root folder of catalog. More...
 

Detailed Description

OFML product catalog.

When a catalog is used, it may keep multiple files open. When you have finished using it, you should dispose of it either directly via Dispose() or indirectly via using().

Member Function Documentation

Catalog X3g::Plugin::Articles::Catalog::Get ( Articles::Package pPackage)
static

Returns catalog from given package.

IList< Catalog^ > X3g::Plugin::Articles::Catalog::GetAll ( )
static

Returns all catalogs from all registered packages.

IList< CatalogItem^ > X3g::Plugin::Articles::Catalog::GetAllItems ( )

Returns all items from the catalog.

Includes invisible items which are not referenced from catalog tree.

Property Documentation

Articles:: Package^ X3g::Plugin::Articles::Catalog::Package
get

Package which contains the catalog.

CatalogItem^ X3g::Plugin::Articles::Catalog::RootItem
get

Root folder of catalog.