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

OFML catalog item. More...

Public Member Functions

System::String^ GetText (CatalogTextPurpose pPurpose)
 Returns text with given purpose in current catalog language. More...
 
System::String^ GetImage (CatalogImagePurpose pPurpose)
 Returns absolute path to image with given purpose. More...
 
System::String^ GetResource (CatalogResourceType pResType)
 Returns resource of given type for current catalog language. More...
 
System::String^ GetResourceDir (CatalogResourceType pResType)
 Returns directory which contains resource files of given type. More...
 
IList< CatalogItem^ >^ GetChildren ()
 Returns children of catalog item. More...
 

Properties

CatalogItemType Type [get]
 Type of catalog item. More...
 
System::String^  ArticleNumber [get]
 Article number of catalog item. More...
 
System::String^  VariantCode [get]
 Variant code of catalog item. More...
 
System::String^  PackageName [get]
 Name of package which contains the referenced item. More...
 
bool InCatalogTree [get]
 Returns if catalog item is referenced from catalog tree. More...
 

Detailed Description

OFML catalog item.

Member Function Documentation

IList< CatalogItem^ > X3g::Plugin::Articles::CatalogItem::GetChildren ( )

Returns children of catalog item.

System::String X3g::Plugin::Articles::CatalogItem::GetImage ( CatalogImagePurpose  pPurpose)

Returns absolute path to image with given purpose.

System::String X3g::Plugin::Articles::CatalogItem::GetResource ( CatalogResourceType  pResType)

Returns resource of given type for current catalog language.

Filenames are relative.

System::String X3g::Plugin::Articles::CatalogItem::GetResourceDir ( CatalogResourceType  pResType)

Returns directory which contains resource files of given type.

System::String X3g::Plugin::Articles::CatalogItem::GetText ( CatalogTextPurpose  pPurpose)

Returns text with given purpose in current catalog language.

Property Documentation

System:: String^ X3g::Plugin::Articles::CatalogItem::ArticleNumber
get

Article number of catalog item.

bool X3g::Plugin::Articles::CatalogItem::InCatalogTree
get

Returns if catalog item is referenced from catalog tree.

System:: String^ X3g::Plugin::Articles::CatalogItem::PackageName
get

Name of package which contains the referenced item.

CatalogItemType X3g::Plugin::Articles::CatalogItem::Type
get

Type of catalog item.

System:: String^ X3g::Plugin::Articles::CatalogItem::VariantCode
get

Variant code of catalog item.