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

Article Instance. More...

Inheritance diagram for X3g::Plugin::IArticleInstance:
Inheritance graph
[legend]

Public Member Functions

IBasketItemgetArticleInformation (bool pPrepareArticleImages)
 Returns a copy of the article information of the currently selected entity. More...
 
bool SetArticleTextField (String^ pTextFieldId, String^ pLang, String^ pText)
 Sets a text field value of the currently selected article. More...
 
void Close ()
 Closes the instance and applies all changes. More...
 

Properties

bool IsValid [get]
 Returns true if this instance is still valid. More...
 
String^  MainEntityId [get]
 The main entity id of this instance (see DbEntity::Id). More...
 
String^  EntityId [get]
 The currently selected entity id of this instance (see DbEntity::Id). More...
 
IPropertyProvider^  PropertyProvider [get]
 The property provider of the currently selected entity. More...
 
ReadOnlyCollection
< System::String^ >^ 
AvailableLanguages [get]
 A list of potentially available languages (two letter ISO codes) for this instance. More...
 
bool IsAlternatePosition [get, set]
 Allows to tag the article as an alternate position. More...
 

Detailed Description

Article Instance.

Member Function Documentation

void X3g::Plugin::IArticleInstance::Close ( )

Closes the instance and applies all changes.

An instance will be invalid after it was closed. The instance gets automatically closed if another article gets instantiated or if it is deselected.

X3g::Plugin::IBasketItem X3g::Plugin::IArticleInstance::getArticleInformation ( bool  pPrepareArticleImages)

Returns a copy of the article information of the currently selected entity.

If the article has changed, this function needs to be called again.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
bool X3g::Plugin::IArticleInstance::SetArticleTextField ( String pTextFieldId,
String pLang,
String pText 
)

Sets a text field value of the currently selected article.

Use IBasketArticleItem::TextFields to get the available text fields.

Parameters
pTextFieldIdThe id of the text field (see IBasketArticleTextField::Id).
pLangThe language of the new text value. If it is null or empty the application language will be used.
pTextThe new text value.
Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.

Property Documentation

ReadOnlyCollection< System:: String^>^ X3g::Plugin::IArticleInstance::AvailableLanguages
get

A list of potentially available languages (two letter ISO codes) for this instance.

String^ X3g::Plugin::IArticleInstance::EntityId
get

The currently selected entity id of this instance (see DbEntity::Id).

bool X3g::Plugin::IArticleInstance::IsAlternatePosition
getset

Allows to tag the article as an alternate position.

Alternate positions are excluded from total price calculation.

bool X3g::Plugin::IArticleInstance::IsValid
get

Returns true if this instance is still valid.

An instance will be invalid after it was closed. (see IArticleInstance::Close()) At any given time there can be only one valid instance.

String^ X3g::Plugin::IArticleInstance::MainEntityId
get

The main entity id of this instance (see DbEntity::Id).

IPropertyProvider^ X3g::Plugin::IArticleInstance::PropertyProvider
get

The property provider of the currently selected entity.