AddCatalogProperty Method (String, Byte[], Int16, String, Int64, DateTime, Decimal, Boolean, Double, Int64, Int64, DateTime, DateTime, Double, Double, Boolean, Boolean, Int32, Int32, Decimal, Decimal, Boolean, String, Boolean, Boolean, Boolean, Boolean, Boolean, String, Boolean, Boolean)

Add a CatalogProperty to this CatalogPropertiesDataSet..::.CatalogPropertiesDataTable and return a CatalogPropertiesDataSet..::.CatalogProperty.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Function AddCatalogProperty ( _
    PropertyName As String, _
    Timestamp As Byte(), _
    DataType As Short, _
    DefaultStringValue As String, _
    DefaultIntegerValue As Long, _
    DefaultDateTimeValue As DateTime, _
    DefaultCurrencyValue As Decimal, _
    DefaultBooleanValue As Boolean, _
    DefaultDoubleValue As Double, _
    MinimumIntegerValue As Long, _
    MaximumIntegerValue As Long, _
    MinimumDateTimeValue As DateTime, _
    MaximumDateTimeValue As DateTime, _
    MinimumDoubleValue As Double, _
    MaximumDoubleValue As Double, _
    IsFreeTextSearchable As Boolean, _
    IncludeInSpecSearch As Boolean, _
    MinimumStringLength As Integer, _
    MaximumStringLength As Integer, _
    MinimumCurrencyValue As Decimal, _
    MaximumCurrencyValue As Decimal, _
    DisplayOnSite As Boolean, _
    DisplayName As String, _
    AssignAll As Boolean, _
    ExportToDW As Boolean, _
    DisplayInProductsList As Boolean, _
    LanguageSensitive As Boolean, _
    IsRequired As Boolean, _
    Currency As String, _
    BuiltIn As Boolean, _
    DisplayAsBase As Boolean _
) As CatalogPropertiesDataSet..::.CatalogProperty

'Usage
Dim instance As CatalogPropertiesDataSet..::.CatalogPropertiesDataTable
Dim PropertyName As String
Dim Timestamp As Byte()
Dim DataType As Short
Dim DefaultStringValue As String
Dim DefaultIntegerValue As Long
Dim DefaultDateTimeValue As DateTime
Dim DefaultCurrencyValue As Decimal
Dim DefaultBooleanValue As Boolean
Dim DefaultDoubleValue As Double
Dim MinimumIntegerValue As Long
Dim MaximumIntegerValue As Long
Dim MinimumDateTimeValue As DateTime
Dim MaximumDateTimeValue As DateTime
Dim MinimumDoubleValue As Double
Dim MaximumDoubleValue As Double
Dim IsFreeTextSearchable As Boolean
Dim IncludeInSpecSearch As Boolean
Dim MinimumStringLength As Integer
Dim MaximumStringLength As Integer
Dim MinimumCurrencyValue As Decimal
Dim MaximumCurrencyValue As Decimal
Dim DisplayOnSite As Boolean
Dim DisplayName As String
Dim AssignAll As Boolean
Dim ExportToDW As Boolean
Dim DisplayInProductsList As Boolean
Dim LanguageSensitive As Boolean
Dim IsRequired As Boolean
Dim Currency As String
Dim BuiltIn As Boolean
Dim DisplayAsBase As Boolean
Dim returnValue As CatalogPropertiesDataSet..::.CatalogProperty

returnValue = instance.AddCatalogProperty(PropertyName, _
    Timestamp, DataType, DefaultStringValue, _
    DefaultIntegerValue, DefaultDateTimeValue, _
    DefaultCurrencyValue, DefaultBooleanValue, _
    DefaultDoubleValue, MinimumIntegerValue, _
    MaximumIntegerValue, MinimumDateTimeValue, _
    MaximumDateTimeValue, MinimumDoubleValue, _
    MaximumDoubleValue, IsFreeTextSearchable, _
    IncludeInSpecSearch, MinimumStringLength, _
    MaximumStringLength, MinimumCurrencyValue, _
    MaximumCurrencyValue, DisplayOnSite, _
    DisplayName, AssignAll, ExportToDW, _
    DisplayInProductsList, LanguageSensitive, _
    IsRequired, Currency, BuiltIn, DisplayAsBase)

public CatalogPropertiesDataSet..::.CatalogProperty AddCatalogProperty(
    string PropertyName,
    byte[] Timestamp,
    short DataType,
    string DefaultStringValue,
    long DefaultIntegerValue,
    DateTime DefaultDateTimeValue,
    decimal DefaultCurrencyValue,
    bool DefaultBooleanValue,
    double DefaultDoubleValue,
    long MinimumIntegerValue,
    long MaximumIntegerValue,
    DateTime MinimumDateTimeValue,
    DateTime MaximumDateTimeValue,
    double MinimumDoubleValue,
    double MaximumDoubleValue,
    bool IsFreeTextSearchable,
    bool IncludeInSpecSearch,
    int MinimumStringLength,
    int MaximumStringLength,
    decimal MinimumCurrencyValue,
    decimal MaximumCurrencyValue,
    bool DisplayOnSite,
    string DisplayName,
    bool AssignAll,
    bool ExportToDW,
    bool DisplayInProductsList,
    bool LanguageSensitive,
    bool IsRequired,
    string Currency,
    bool BuiltIn,
    bool DisplayAsBase
)

public:
CatalogPropertiesDataSet..::.CatalogProperty^ AddCatalogProperty(
    String^ PropertyName, 
    array<unsigned char>^ Timestamp, 
    short DataType, 
    String^ DefaultStringValue, 
    long long DefaultIntegerValue, 
    DateTime DefaultDateTimeValue, 
    Decimal DefaultCurrencyValue, 
    bool DefaultBooleanValue, 
    double DefaultDoubleValue, 
    long long MinimumIntegerValue, 
    long long MaximumIntegerValue, 
    DateTime MinimumDateTimeValue, 
    DateTime MaximumDateTimeValue, 
    double MinimumDoubleValue, 
    double MaximumDoubleValue, 
    bool IsFreeTextSearchable, 
    bool IncludeInSpecSearch, 
    int MinimumStringLength, 
    int MaximumStringLength, 
    Decimal MinimumCurrencyValue, 
    Decimal MaximumCurrencyValue, 
    bool DisplayOnSite, 
    String^ DisplayName, 
    bool AssignAll, 
    bool ExportToDW, 
    bool DisplayInProductsList, 
    bool LanguageSensitive, 
    bool IsRequired, 
    String^ Currency, 
    bool BuiltIn, 
    bool DisplayAsBase
)

public function AddCatalogProperty(
    PropertyName : String, 
    Timestamp : byte[], 
    DataType : short, 
    DefaultStringValue : String, 
    DefaultIntegerValue : long, 
    DefaultDateTimeValue : DateTime, 
    DefaultCurrencyValue : decimal, 
    DefaultBooleanValue : boolean, 
    DefaultDoubleValue : double, 
    MinimumIntegerValue : long, 
    MaximumIntegerValue : long, 
    MinimumDateTimeValue : DateTime, 
    MaximumDateTimeValue : DateTime, 
    MinimumDoubleValue : double, 
    MaximumDoubleValue : double, 
    IsFreeTextSearchable : boolean, 
    IncludeInSpecSearch : boolean, 
    MinimumStringLength : int, 
    MaximumStringLength : int, 
    MinimumCurrencyValue : decimal, 
    MaximumCurrencyValue : decimal, 
    DisplayOnSite : boolean, 
    DisplayName : String, 
    AssignAll : boolean, 
    ExportToDW : boolean, 
    DisplayInProductsList : boolean, 
    LanguageSensitive : boolean, 
    IsRequired : boolean, 
    Currency : String, 
    BuiltIn : boolean, 
    DisplayAsBase : boolean
) : CatalogPropertiesDataSet..::.CatalogProperty

Parameters

• PropertyName
  Type: System..::.String
  Property name of new property.

• Timestamp
  Type: array<System..::.Byte>[]()[]
  The timestamp used for control

• DataType
  Type: System..::.Int16
  Data type of new property.

• DefaultStringValue
  Type: System..::.String
  The string value for the property when it is created.

• DefaultIntegerValue
  Type: System..::.Int64
  The default integer value.

• DefaultDateTimeValue
  Type: System..::.DateTime
  The default DateTime value.

• DefaultCurrencyValue
  Type: System..::.Decimal
  The default currency.

• DefaultBooleanValue
  Type: System..::.Boolean
  The default boolean value.

• DefaultDoubleValue
  Type: System..::.Double
  The default value for a double.

• MinimumIntegerValue
  Type: System..::.Int64
  The minimum value for an integer.

• MaximumIntegerValue
  Type: System..::.Int64
  The maximum value for an integer.

• MinimumDateTimeValue
  Type: System..::.DateTime
  The minimum DateTime value.

• MaximumDateTimeValue
  Type: System..::.DateTime
  The maximum DateTime value.

• MinimumDoubleValue
  Type: System..::.Double
  The minimum value for a double.

• MaximumDoubleValue
  Type: System..::.Double
  The maximum value for a double.

• IsFreeTextSearchable
  Type: System..::.Boolean
  Attribute represents if a property is freetextsearchable or not.

• IncludeInSpecSearch
  Type: System..::.Boolean
  Attribute represents if a property should be included in specification searchable results

• MinimumStringLength
  Type: System..::.Int32
  Minimum length of the new property (if string type)

• MaximumStringLength
  Type: System..::.Int32
  Maximum length of the new property (if string type)

• MinimumCurrencyValue
  Type: System..::.Decimal
  The minimum value of the currency associated with this Property.

• MaximumCurrencyValue
  Type: System..::.Decimal
  The maximum value of the currency associated with this Property.

• DisplayOnSite
  Type: System..::.Boolean
  Attribute represents if a property should be displayed on the site or not

• DisplayName
  Type: System..::.String
  Language insensitive Display name

• AssignAll
  Type: System..::.Boolean
  Represents if a property should be added to all the product catalogs or not

• ExportToDW
  Type: System..::.Boolean
  Export this property to DW

• DisplayInProductsList
  Type: System..::.Boolean
  Attribute represents if the property should be displayed in the products list

• LanguageSensitive
  Type: System..::.Boolean
  Allow multiilanggual catalogs.

• IsRequired
  Type: System..::.Boolean
  Attribute represents if a value for this property should be specified in categories and products in catalogs.

• Currency
  Type: System..::.String
  Represents the currency associate with this property

• BuiltIn
  Type: System..::.Boolean
  true for a built in catalog property; otherwise false.

• DisplayAsBase
  Type: System..::.Boolean
  true to allow to display this catalog as a base; otherwise false.

Return Value

Type: Microsoft.CommerceServer.Catalog..::.CatalogPropertiesDataSet..::.CatalogProperty
A CatalogPropertiesDataSet..::.CatalogProperty containing the added CatalogProperty.

Remarks

The CatalogPropertiesDataSet object must be saved before these changes will be persisted to the database.

Permissions

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CatalogPropertiesDataSet..::.CatalogPropertiesDataTable Class

CatalogPropertiesDataSet..::.CatalogPropertiesDataTable Members

AddCatalogProperty Overload

Microsoft.CommerceServer.Catalog Namespace