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

User article instance. More...

Inheritance diagram for X3g::Plugin::Articles::UserArticleInstance:
Inheritance graph
[legend]

Public Member Functions

CustomTextFieldAddCustomTextField (String^ pKey, String^ pValue, bool pEditable)
 Adds a custom text field. More...
 
CustomTextFieldGetCustomTextField (String^ pKey)
 Returns custom text field. More...
 
IList< CustomTextField^ >^ GetAllCustomTextFields ()
 Returns list of existing custom text fields. More...
 
void DeleteCustomTextField (String^ pKey)
 Removes a custom text field. More...
 
- Public Member Functions inherited from X3g::Plugin::Articles::ArticleInstance
void Close ()
 Closes the instance and applies all changes. More...
 

Properties

String^  ManufacturerId [get, set]
 The article's manufacturer id. More...
 
String^  SeriesId [get, set]
 The article's series id. More...
 
String^  ArticleNumber [get, set]
 The article's number. More...
 
Currency^  PurchasePrice [get, set]
 The purchase price. More...
 
Currency^  SalesPrice [get, set]
 The sales price. More...
 
String^  ShortText [get, set]
 The article's short description. More...
 
String^  LongText [get, set]
 The article's long description. More...
 
String^  VariantText [get, set]
 The article's variant text. More...
 
String^  AdditionalText [get, set]
 The article's additional text. More...
 
- Properties inherited from X3g::Plugin::Articles::ArticleInstance
DbEntity^  MainEntity [get]
 The main entity id of this instance. More...
 
DbEntity^  SelectedEntity [get]
 The currently selected entity of this instance. More...
 
PropertyProvider^  Properties [get]
 Provides properties for the currently selected entity. More...
 
bool Valid [get]
 Returns true if this instance is still valid. More...
 

Additional Inherited Members

- Events inherited from X3g::Plugin::Articles::ArticleInstance
static System::EventHandler^  AnyInstanceOpened [add, remove, raise]
 Fired when an article has been instantiated. More...
 
static System::EventHandler^  AnyInstanceClosing [add, remove, raise]
 Fired when current instance is about to be closed. More...
 
static System::EventHandler^  AnyInstanceClosed [add, remove, raise]
 Fired when an instance has been closed. More...
 

Detailed Description

User article instance.

Member Function Documentation

CustomTextField X3g::Plugin::Articles::UserArticleInstance::AddCustomTextField ( String pKey,
String pValue,
bool  pEditable 
)

Adds a custom text field.

Overwrites existing text field with same key with given values. New field is visible by default.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
void X3g::Plugin::Articles::UserArticleInstance::DeleteCustomTextField ( String pKey)

Removes a custom text field.

Parameters
pKeyThe key of the text field.
Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
IList< CustomTextField^ > X3g::Plugin::Articles::UserArticleInstance::GetAllCustomTextFields ( )

Returns list of existing custom text fields.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
CustomTextField X3g::Plugin::Articles::UserArticleInstance::GetCustomTextField ( String pKey)

Returns custom text field.

Parameters
pKeyThe key of the text field.
Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.

Property Documentation

String^ X3g::Plugin::Articles::UserArticleInstance::AdditionalText
getset

The article's additional text.

Exceptions
System::ExceptionSetter throws exception if this instance is no longer valid.
String^ X3g::Plugin::Articles::UserArticleInstance::ArticleNumber
getset

The article's number.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
String^ X3g::Plugin::Articles::UserArticleInstance::LongText
getset

The article's long description.

Exceptions
System::ExceptionSetter throws exception if this instance is no longer valid.
String^ X3g::Plugin::Articles::UserArticleInstance::ManufacturerId
getset

The article's manufacturer id.

Each manufacturer has a unique ID assigned by EasternGraphics. If you set the manufacturer id to an invalid value, articles may not be processed in some applications.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
System::ArgumentExceptionAn exception will be thrown if set to an invalid ID.
Currency^ X3g::Plugin::Articles::UserArticleInstance::PurchasePrice
getset

The purchase price.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
Currency^ X3g::Plugin::Articles::UserArticleInstance::SalesPrice
getset

The sales price.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
String^ X3g::Plugin::Articles::UserArticleInstance::SeriesId
getset

The article's series id.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
System::ArgumentExceptionAn exception will be thrown if set to an invalid ID.
String^ X3g::Plugin::Articles::UserArticleInstance::ShortText
getset

The article's short description.

Exceptions
System::ExceptionSetter throws exception if this instance is no longer valid.
String^ X3g::Plugin::Articles::UserArticleInstance::VariantText
getset

The article's variant text.

Exceptions
System::ExceptionSetter throws exception if this instance is no longer valid.