WizPageData Class

Helper class for managing a wizard's UserData. The IWizardTemplate uses the UserData collection to mananage data across wizard pages. This class provides a number of useful facilities based around the idea of accessing the data by InstanceName. Note that all values are stored as strings.

These factilities fall into the following groups:

Methods for getting and setting UserData values in the instantiated instance:
- Determine if an item exists using ContainsKey(String).
- Add/modify a value using SetValue(String, String).
- Get the value of an item as a boolean using GetBool(String).
- Get the value of an item as a DateTime using GetDateTime(String) or GetDateTime(String, DateTime).
- Get the value of an item as a doubler using GetDouble(String, Double).
- Get the value of an item as an integer using GetInt(String) or GetInt(String, Int32).
- Get the value of an item as a string using GetString(String).
Methods for managing selected items in lists by RowKey (with methods for current instance and other instances):
- Determine if an a particular item is selected using IsSelected(String) or IsSelected(String, String).
- Add an item to the list of selected items using AddRowKey(String) or AddRowKey(String, String).
- Clear the list of selected items using ClearRowKeys or ClearRowKeys(String).
- Remove from the list of selected items using RemoveRowKey(String) or RemoveRowKey(String, String).
- Get the list of selected items (as an array) using GetRowKeyArray or GetRowKeyArray(String).
- Get the list of selected items (as semi-colon separated list) using GetRowKeys or GetRowKeys(String).
- Add multiple items to the list of selected items (as an array) using SetRowKeys(String) or SetRowKeys(String, String).
- Add multiple items to the list of selected items (as semi-colon separated list) using SetRowKeys(String) or SetRowKeys(String, String).
Methods for getting and setting UserData values in another instance:
- Determine if an item exists using ContainsKey(String, String).
- Add/modify a value using SetValue(String, String, String).
- Get the value of an item using GetString(String, String) or GetString(String, String, String).
Tools for programmatic debugging, specifically DebugList.
List management items primarily intended for internal use:
- Get the key used to store a particular item in UserData (used to access UserData directly), using Key(String) or Key(String, String).
- Get the InstanceName of the current WizPageData instance using InstanceName.

Inheritance Hierarchy

SystemObject
NetQuarryWizPageData

Namespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

Copy

public class WizPageData

Public Class WizPageData

The WizPageData type exposes the following members.

Constructors

	Name	Description
	WizPageData(IWizPage)	Constructor for use within a page.
	WizPageData(IWizardTemplate, String)	Constructor for use from outside a page.

Top

Properties

	Name	Description
	Count	Determines the number of data items in the current instance (see InstanceName).
	DebugList	Provides a list of name/value pairs for this page data for viewing in the debugger. For performance reasons the WizPageData object does not copy the UserData, but simply references it. Because of this and the unordered nature of a Hashtable, Use DebugList to view the data in this object. For performance reasons you should not use this except for debugging.
	HasItems	Determines whether or not there are any data items for the current instance (see InstanceName).
	InstanceName	The name of the current wizard PageElementInfo instance. The instance name is taken from the InstanceName property on the PageElementInfo if one is specified. If not, the instance name is defaulted from the PageElement's Name.

Top

Methods

	Name	Description
	AddRowKey(String)	Adds a row key, if not already present, to the list of selected row keys for the current instance.
	AddRowKey(String, String)	Adds a row key, if not already present, to the list of selected row keys for the specified instance.
	ClearRowKeys	Clear the selected row keys for the current instance.
	ClearRowKeys(String)	Clear the selected row keys for the specified instance.
	ContainsKey(String)	Determines if a particular item exists in the wizard's page data. In this overload the current instance is assumed.
	ContainsKey(String, String)	Determines if a particular item exists in the wizard's page data. In this overload the instance name is explicitly specified allowing searching for data for pages other than the current page.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetBool	Get the boolean value for the named item in the current instance's page data.
	GetDateTime(String)	Get the DateTime value for the named item in the wizard's page data. The current instance is assumed. Note that this is equivalent to calling EAPConvert.ToDateTime(data.GetString(itemName)).
	GetDateTime(String, DateTime)	Get the DateTime value for the named item in the wizard's page data. The current instance is assumed. Note that this is equivalent to calling EAPConvert.ToDateTime(data.GetString(itemName), defaultValue).
	GetDouble	Get the double value for the named item in the wizard's page data. The current instance is assumed. Note that this is equivalent to calling EAPUtil.ToDouble(data.GetString(itemName), defaultValue).
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInt(String)	Get the integer value for the named item in the wizard's page data. The current instance is assumed. Note that this is equivalent to calling EAPUtil.ToInt(data.GetString(itemName)).
	GetInt(String, Int32)	Get the integer value for the named item in the wizard's page data. The current instance is assumed. Note that this is equivalent to calling EAPUtil.ToInt(data.GetString(itemName), defaultValue).
	GetRowKeyArray	Gets an array of row keys for the selected items in the current instance.
	GetRowKeyArray(String)	Gets an array of row keys for the selected items in the specified instance.
	GetRowKeys	Gets a semi-colon separated list of row keys for the selected items in the current instance.
	GetRowKeys(String)	Gets a semi-colon separated list of row keys for the selected items in the specified instance.
	GetString(String)	Get the string value for the named item in the wizard's page data. In this overload the current instance is assumed.
	GetString(String, String)	Get the string value for the named item in the wizard's page data. In this overload the instance name is explicitly specified allowing getting data for pages other than the current page.
	GetString(String, String, String)	Get the string value for the named item in the wizard's page data if found, else the provided default. In this overload the instance name is explicitly specified allowing getting data for pages other than the current page.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSelected(String)	Determines if the specified row key, in the current page instance, was selected.
	IsSelected(String, String)	Determines if the specified row key, in the specified page instance, was selected.
	Key(String)	The Key for indexing into the wizard's page data. This key is composed of the page instance name together with the item name. In this overload the current instance is assumed.
	Key(String, String)	The Key for indexing into the wizard's page data. This key is composed of the page instance name together with the item name. In this overload the instance name is explicitly specified allowing indexing into data for pages other than the current page.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveRowKey(String)	Removes a row key, if present, from the list of selected row keys for the current instance.
	RemoveRowKey(String, String)	Removes a row key, if present, from the list of selected row keys for the specified instance.
	SetRowKeys(String)	Add the provided semi-colon separated list of row keys for the current instance.
	SetRowKeys(String)	Add the provided array of row keys for the current instance.
	SetRowKeys(String, String)	Add the provided semi-colon separated list of row keys for the specified instance.
	SetRowKeys(String, String)	Add the provided array of row keys for the specified instance.
	SetValue(String, String)	Set the named value into the wizard's page data. If the item already exists its value will be replaced with the specified value. In this overload the current instance is assumed.
	SetValue(String, String, String)	Set the named value into the wizard's page data. If the item already exists its value will be replaced with the specified value. In this overload the instance name is explicitly specified allowing setting data for pages other than the current page.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	EqualValue	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

Remarks

UserData for PageElements in a wizard are organized around instances idenified by InstanceName. By default, a PageElement's InstanceName is taken from the Name. However, it is often desirable to group multiple elements into a single instance by specifing the InstanceName on each such element. If an InstanceName is specified it overrides the default.

Reference

NetQuarry Namespace