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

Provides information about registered OFML packages. More...

Public Member Functions

IList< System::String^ >^ GetLanguages ()
 Returns languages which are supported by the package. More...
 
System::String^ GetManufacturerName (System::String^ pLanguage)
 Returns name of manufacturer in given language. More...
 
System::String^ GetProgramName (System::String^ pLanguage)
 Returns name of the program in given language. More...
 
System::String^ GetValue (System::String^ pKey, System::String^ pLanguage)
 Returns arbitrary values from package profile (see DSR specification). More...
 
IList< Package^ >^ GetCatalogPackages ()
 Returns other catalog packages which reference products from this package. More...
 

Static Public Member Functions

static IList< Package^ >^ GetAll ()
 Returns all registered packages. More...
 
static PackageGet (System::String^ pPackageName)
 Returns registered package with given name. More...
 

Properties

System::String^  Manufacturer [get]
 Unique OFML identifier of the manufacturer (e.g. More...
 
System::String^  Program [get]
 Unique OFML identifier of the OFML library (series) within the manufacturer (e.g. More...
 
System::String^  DistributionRegion [get]
 Identifier of the distribution region (e.g. More...
 
System::Version^  Version [get]
 Version number of the package. More...
 
System::String^  ProgId [get]
 OFML program id. More...
 
System::String^  ManufacturerId [get]
 Unique commercial identifier of the manufacturer (e.g. More...
 
System::String^  ProgramIds [get]
 Unique commercial identifiers of commercial product lines within the manufacturer which are mapped in this package. More...
 
System::String^  DataDir [get]
 Root dictionary for product data (e.g. More...
 
System::String^  PackageDir [get]
 Root dictionary for current package (e.g. More...
 
System::String^  Path [get]
 Path to package data for actual distribution region and version (e.g. More...
 
PackageType Type [get]
 Type of the package. More...
 
System::String^  VersionedName [get]
 Name of package including version (e.g. More...
 
System::String^  ManufacturerLogoSmall [get]
 Returns absolute path to small manufacturer logo ([1-100]x20 pixel). More...
 
System::String^  ManufacturerLogoLarge [get]
 Returns absolute path to large manufacturer logo ([1-200]x40 pixel). More...
 

Detailed Description

Provides information about registered OFML packages.

Member Function Documentation

Package X3g::Plugin::Articles::Package::Get ( System::String^  pPackageName)
static

Returns registered package with given name.

Returns
Returns null if package was not found.
IList< Package^ > X3g::Plugin::Articles::Package::GetAll ( )
static

Returns all registered packages.

IList< Package^ > X3g::Plugin::Articles::Package::GetCatalogPackages ( )

Returns other catalog packages which reference products from this package.

Returns
Returns null if key was not found.
IList< System::String^ > X3g::Plugin::Articles::Package::GetLanguages ( )

Returns languages which are supported by the package.

System::String ^ X3g::Plugin::Articles::Package::GetManufacturerName ( System::String^  pLanguage)

Returns name of manufacturer in given language.

Default manufacturer name is returned if language is not available or null.

System::String ^ X3g::Plugin::Articles::Package::GetProgramName ( System::String^  pLanguage)

Returns name of the program in given language.

Default program name is returned if language is not available or null.

System::String X3g::Plugin::Articles::Package::GetValue ( System::String^  pKey,
System::String^  pLanguage 
)

Returns arbitrary values from package profile (see DSR specification).

Parameters
pKeySee DSR specification for possible values.
pLanguageSet null for values which are not localized.
Returns
Returns null if key was not found.

Property Documentation

System:: String^ X3g::Plugin::Articles::Package::DataDir
get

Root dictionary for product data (e.g.

C:/EasternGraphics).

System:: String^ X3g::Plugin::Articles::Package::DistributionRegion
get

Identifier of the distribution region (e.g.

DE).

System:: String^ X3g::Plugin::Articles::Package::Manufacturer
get

Unique OFML identifier of the manufacturer (e.g.

egr).

System:: String^ X3g::Plugin::Articles::Package::ManufacturerId
get

Unique commercial identifier of the manufacturer (e.g.

EG).

System:: String^ X3g::Plugin::Articles::Package::ManufacturerLogoLarge
get

Returns absolute path to large manufacturer logo ([1-200]x40 pixel).

System:: String^ X3g::Plugin::Articles::Package::ManufacturerLogoSmall
get

Returns absolute path to small manufacturer logo ([1-100]x20 pixel).

System:: String^ X3g::Plugin::Articles::Package::PackageDir
get

Root dictionary for current package (e.g.

C:/EasternGraphics/egr/office2).

System:: String^ X3g::Plugin::Articles::Package::Path
get

Path to package data for actual distribution region and version (e.g.

C:/EasternGraphics/egr/office2/EGR/1).

System:: String^ X3g::Plugin::Articles::Package::ProgId
get

OFML program id.

(e.g. )

System:: String^ X3g::Plugin::Articles::Package::Program
get

Unique OFML identifier of the OFML library (series) within the manufacturer (e.g.

office2).

System:: String^ X3g::Plugin::Articles::Package::ProgramIds
get

Unique commercial identifiers of commercial product lines within the manufacturer which are mapped in this package.

Identifiers are separated by semicolon. (e.g. AX;BX)

PackageType X3g::Plugin::Articles::Package::Type
get

Type of the package.

System:: Version^ X3g::Plugin::Articles::Package::Version
get

Version number of the package.

System:: String^ X3g::Plugin::Articles::Package::VersionedName
get

Name of package including version (e.g.

::egr::office2::1).