CascadingDropDown Reference

Modified on 2010/05/04 15:14 by Stephen Walther — Categorized as: Uncategorized

CascadingDropDown Server Reference

CascadingDropDown extender class definition

CascadingDropDown Server Properties

NameDescription
Category Category of this DropDownList (used when communicating with the helper web service)
ContextKey User/page specific context provided to an optional overload of the web method described by ServiceMethod/ServicePath. If the context key is used, it should have the same signature with an additional parameter named contextKey of type string.
EmptyText Optional text for the option displayed when the list is empty
EmptyValue Optional value for the option displayed when the list is empty
LoadingText Optional text displayed by a DropDownList when it is loading its data
ParentControlID Optional ID of the parent DropDownList (upon which the contents of this control are based)
PromptText Optional text displayed by a DropDownList the user has not yet touched. If omitted, first item in the dropdown is selected
PromptValue Optional value for the option displayed by a DropDownList showing the PromptText
SelectedValue Selected value of the drop down
ServiceMethod Name of the web service method
ServicePath Path to the helper web service
UseContextKey Whether or not the ContextKey property should be used. This will be automatically enabled if the ContextKey property is ever set (on either the client or the server). If the context key is used, it should have the same signature with an additional parameter named contextKey of type string.

CascadingDropDown Server Methods

NameDescription
Constructor Constructor
CascadingDropDown_ClientStateValuesLoaded(System.Object, System.EventArgs) Populate DropDownLists with their SelectedValues
ParseKnownCategoryValuesString(System.String) Helper method to parse the private storage format used to communicate known category/value pairs
QuerySimpleCascadingDropDownDocument(System.Xml.XmlDocument, System.String[], System.Collections.Specialized.StringDictionary, System.String) Helper method to provide a simple implementation of a method to query a data set and return the relevant drop down contents
QuerySimpleCascadingDropDownDocument(System.Xml.XmlDocument, System.String[], System.Collections.Specialized.StringDictionary, System.String, System.Text.RegularExpressions.Regex) Helper method to provide a simple implementation of a method to query a data set and return the relevant drop down contents
ShouldSerializeServicePath Prevent the service path from being serialized when it's empty

CascadingDropDownBehavior Client Reference

The CascadingDropDownBehavior is used to populate drop downs with values from a web service

CascadingDropDownBehavior Client Properties

NameDescription
CategoryCategory of this drop down
contextKeyUser/page specific context provided to an optional overload of the web method described by ServiceMethod/ServicePath. If the context key is used, it should have the same signature with an additional parameter named contextKey of type string.
EmptyTextText for the option displayed when the list is empty
EmptyValueValue for the option displayed when the list is empty
LoadingTextLoading text to to be displayed when getting the drop down's values from the web service
ParentControlIDID of the parent drop down in a hierarchy of drop downs
PromptTextPrompt text displayed as the first entry in the drop down
PromptValueValue for the option displayed by a DropDownList showing the PromptText
SelectedValueSelected value of the drop down
ServiceMethodName of the method to invoke on the web service
ServicePathPath to the web service
useContextKeyWhether or not the ContextKey property should be used. This will be automatically enabled if the ContextKey property is ever set (on either the client or the server). If the context key is used, it should have the same signature with an additional parameter named contextKey of type string.

CascadingDropDownBehavior Client Methods

NameDescription
dispose Dispose the behavior
initialize Initialize the behavior
raisePopulated Raise the populated event
raisePopulating Raise the populating event
raiseSelectionChanged Raise the selectionChanged event

CascadingDropDownBehavior Client Events

NameDescription
populated Add an event handler for the populated event
populating Add an event handler for the populating event
selectionChanged Add an event handler for the selectionChanged event