pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Classes | Typedefs | Enumerations | Functions
X3g::Plugin::Articles Namespace Reference

Namespace provides access to article handling. More...

Classes

class  ArticleEntityInfo
 Provides additional article information. More...
 
class  ArticleEntity
 Article interface for entities. More...
 
class  ArticleInstance
 Article instance. More...
 
class  OfmlArticleInstance
 OFML article instance. More...
 
class  CustomTextField
 Custom text field of user article. More...
 
class  UserArticleInstance
 User article instance. More...
 
class  ArticleInsertedEventArgs
 Provides information about the inserted article. More...
 
class  CatalogItem
 OFML catalog item. More...
 
class  Catalog
 OFML product catalog. More...
 
class  OfmlObject
 Ofml Object. More...
 
class  OfmlEval
 A class covering the evaluation of OFML expressions. More...
 
class  Package
 Provides information about registered OFML packages. More...
 
class  ProjectSettings
 ProjectSettings. More...
 

Typedefs

typedef System::EventHandler
< ArticleInsertedEventArgs^ > 
ArticleInsertedEventHandler
 Event handler for the event that an article has been inserted. More...
 

Enumerations

enum  ArticleDescriptionType { ArticleDescriptionType::Default, ArticleDescriptionType::Short, ArticleDescriptionType::Long, ArticleDescriptionType::Features }
 The type of the article description. More...
 
enum  ArticleNumberType {
  ArticleNumberType::Default, ArticleNumberType::Base, ArticleNumberType::Final, ArticleNumberType::VariantCode,
  ArticleNumberType::OfmlVariantCode
}
 The type of the article number. More...
 
enum  CatalogItemType {
  CatalogItemType::Unknown, CatalogItemType::Article, CatalogItemType::Folder, CatalogItemType::Information,
  CatalogItemType::MethodCall, CatalogItemType::FunctionCall, CatalogItemType::MetaPlanning, CatalogItemType::Graphics
}
 Type of catalog item. More...
 
enum  CatalogTextPurpose { CatalogTextPurpose::Label, CatalogTextPurpose::Description }
 Predefined purposes for catalog texts. More...
 
enum  CatalogImagePurpose { CatalogImagePurpose::Icon, CatalogImagePurpose::Image }
 Predefined purposes for catalog images. More...
 
enum  CatalogResourceType { CatalogResourceType::Graphics, CatalogResourceType::Html, CatalogResourceType::Mime, CatalogResourceType::Url }
 Type of catalog resource. More...
 
enum  PackageType {
  PackageType::Unknown, PackageType::Found, PackageType::Product, PackageType::ProductWithCatalog,
  PackageType::Catalog
}
 Type of package. More...
 

Functions

public delegate bool AssignDefaultPropValuesHandler (OfmlObject^ pObject)
 Assign default property values to a OfmlObject handler. More...
 

Detailed Description

Namespace provides access to article handling.

Typedef Documentation

Event handler for the event that an article has been inserted.

The event argument has to be of type ArticleInsertedEventArgs.

Enumeration Type Documentation

The type of the article description.

Enumerator
Default 

The short and/or long description, according to the product data's defaults.

Short 

The short description.

Long 

The long description.

Features 

The features description.

The type of the article number.

Enumerator
Default 

The base or final article number according to the product data defaults.

Base 

The base article number.

Final 

The final article number.

VariantCode 

The variant code.

OfmlVariantCode 

The OFML variant code.

Predefined purposes for catalog images.

Enumerator
Icon 

image for presentation in catalog view

Image 

image for high resolution presentation of catalog item

Type of catalog item.

Enumerator
Unknown 

unknown item type

Article 

insertable article

Folder 

catalog folder

Information 

additional information

MethodCall 

method call on selected planning element

FunctionCall 

static class method call

MetaPlanning 

metaplanning workflow

Graphics 

insertable graphics file (e.g. dwg, pec, 3ds)

Type of catalog resource.

Enumerator
Graphics 

insertable graphics file (e.g. dwg, pec, 3ds)

Html 

file in HTML format

Mime 

MIME type (e.g. "application/pdf;info.pdf")

Url 

fully qualified URL to internet resource

Predefined purposes for catalog texts.

Enumerator
Label 

text for presentation in catalog view

Description 

longer descriptive text, e.g. for tooltips

Type of package.

Enumerator
Unknown 

unknown package type

Found 

basic OFML library without product data and catalog data

Product 

OFML library with product data.

ProductWithCatalog 

OFML library with product data and catalog data.

Catalog 

catalog data without product data

Function Documentation

public delegate bool X3g::Plugin::Articles::AssignDefaultPropValuesHandler ( OfmlObject^  pObject)

Assign default property values to a OfmlObject handler.

Returns
The function should return true if properties have been modified.