Click or drag to resize

PicklistItem Class

Holds a single row in a Picklist. A pick list contains a collection of PicklistItem objects.
Inheritance Hierarchy
SystemObject
  NetQuarryPicklistItem

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
[SerializableAttribute]
public class PicklistItem : ICloneable

The PicklistItem type exposes the following members.

Constructors
  NameDescription
Public methodPicklistItem(Object, String)
ctor, creates an instance of a PicklistItem.
Public methodPicklistItem(Object, String, String)
overloaded ctor, creates an instance of a PicklistItem.
Public methodPicklistItem(Object, String, Type)
overloaded ctor, creates an instance of a PicklistItem
Public methodPicklistItem(Object, String, String, String)
Constructor creates an instance of a PicklistItem with a possible group.
Public methodPicklistItem(Object, String, Type, String)
Constructor, creates an instance of a PicklistItem with an optional group.
Public methodPicklistItem(Object, String, String, PicklistItemAttrs, Type)
overloaded ctor, creates an instance of a PicklistItem
Public methodPicklistItem(Object, String, String, String, PicklistItemAttrs)
Constructor creates an instance of a PicklistItem with a possible group.
Public methodPicklistItem(Object, String, String, PicklistItemAttrs, Type, String, String, String, Int32)
Overloaded ctor, creates an instance of a PicklistItem. This version of the ctor is specifically intended for StandardLookup items by accepting the picklistItemID which is the value from the xmt_picklist_item.picklist_item_id column.
Public methodPicklistItem(Object, String, String, PicklistItemAttrs, Type, String, String, String, Int32, String, PicklistAttrs)
Overloaded constructor, creates an instance of a PicklistItem. This version of the constructor is specifically intended for StandardLookup items with grouping by accepting the picklistItemID which is the value from the xmt_picklist_item.picklist_item_id column.
Top
Properties
  NameDescription
Public propertyAltInt
Returns the alternate integer. The alternate integer will be used as the key for the picklist item if the PicklistAttrs.StoreAltInt attribute is set. If not, alternate integer provides a way to associate locale-insensitive integer data with a picklist item.
Public propertyAltText
Returns the alternate text. The alternate text will be used as the key for the picklist item if the PicklistAttrs.StoreAltText attribute is set. If not, alternate text provides a way to associate locale-insensitive text data with a picklist item.
Public propertyAttributes
Gets/sets the item's PicklistItemAttrs.
Public propertyDiscrim
Gets the item's discriminator. The discriminator value is used to group PicklistItem objects in a particular Picklist into sets of values that are mutually exclusive. For example, you could have a Picklist of states in various countries where all of the states in a paricular country would have the same Discrim. Picklists configured in this manner can be used to support cascading comboboxes. In this case a Countries combobox could be used to populate the available values in a States combobox.

When used on a mapper IField the field's Discrim property must be set. The DISCRIM value should almost always be a field reference of the form "[field-key]" which tells the mapper that it should use the set of picklist values whose DISCRIM matches the value for that field in the current row. For the above states example, the DISCRIM setting for the states field would be something like [country].

Public propertyDisplayText
Gets/Sets the display text of the item
Public propertyGroup
Grouping value for picklist item. Group is ignored unless the browser supports the <optgroup> tag and the OptionGroupAdapter is installed (via a .browser file).
Public propertyImagePath
Gets/Sets the ImagePath value.
Public propertyName
Gets/sets the name of the item.
Public propertyPicklistItemID
The unique ID (picklist_item_id) for this item in the xmt_picklist_items table.
Public propertyToolTip
Gets/sets the tooltip for the item.
Public propertyValue
Returns the value of the item.
Public propertyValueAsString
Get the value of this item, converted to a string.
Public propertyValueType
The system.type of the value. (Default is String)
Top
Methods
  NameDescription
Public methodClone
Creates and returns a copy of this PicklistItem.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExtractImageAndTip
Extracts the ItemImage and Item tooltip from the display text
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHashKey
Get the hash key for the item.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also