Article Instance.
More...
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.
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::Exception | An 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
-
pTextFieldId | The id of the text field (see IBasketArticleTextField::Id). |
pLang | The language of the new text value. If it is null or empty the application language will be used. |
pText | The new text value. |
- Exceptions
-
System::Exception | An exception will be thrown if this instance is no longer valid. |
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 |
IPropertyProvider^ X3g::Plugin::IArticleInstance::PropertyProvider |
|
get |
The property provider of the currently selected entity.