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

Article interface for entities. More...

Public Member Functions

ArticleEntityInfoGetInformation ()
 Receives additional article information. More...
 
bool IsUpToDate ()
 Returns true if the article is based on the currently installed product data (OFML). More...
 
IList< ArticleEntity^ >^ GetChildArticles ()
 Receives a list of child articles. More...
 
ImageGetCustomArticleImage ()
 Returns custom article image for article list. More...
 
void SetCustomArticleImage (Image^ pImage)
 Sets custom image for article list. More...
 

Static Public Member Functions

static ArticleEntityFromEntity (DbEntity^ pEntity)
 Retrieves article interface for the given entity. More...
 

Properties

DbBlockReference^  Entity [get]
 The according database entity. More...
 
ArticleEntityType Type [get]
 The article type. More...
 
ArticleGeometryMode GeometryMode [get]
 Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning. More...
 

Detailed Description

Article interface for entities.

Member Function Documentation

ArticleEntity X3g::Plugin::Articles::ArticleEntity::FromEntity ( DbEntity pEntity)
static

Retrieves article interface for the given entity.

Returns null if the given entity doesn't represent an article.

ArticleManager::PrepareArticleEntities() needs to be called once before using this function. Otherwise, the funcion may return null or an article with an invalid BasketId.

IList< ArticleEntity^ > X3g::Plugin::Articles::ArticleEntity::GetChildArticles ( )

Receives a list of child articles.

Image X3g::Plugin::Articles::ArticleEntity::GetCustomArticleImage ( )

Returns custom article image for article list.

Returns null if no custom image is set.

ArticleEntityInfo X3g::Plugin::Articles::ArticleEntity::GetInformation ( )

Receives additional article information.

bool X3g::Plugin::Articles::ArticleEntity::IsUpToDate ( )

Returns true if the article is based on the currently installed product data (OFML).

Otherwise it is unknown if the article is up-to-date or not.

void X3g::Plugin::Articles::ArticleEntity::SetCustomArticleImage ( Image pImage)

Sets custom image for article list.

Set null to remove current custom article image.

Property Documentation

DbBlockReference^ X3g::Plugin::Articles::ArticleEntity::Entity
get

The according database entity.

ArticleGeometryMode X3g::Plugin::Articles::ArticleEntity::GeometryMode
get

Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning.

ArticleEntityType X3g::Plugin::Articles::ArticleEntity::Type
get

The article type.