Build Your Own ASP.NET 3.5 Website Using C# & VB (114 page)

step; possible values are Button, Image, or Link

HeaderStyle

represents the style properties of the header area

HeaderTemplate

specifies the template that’s used to display the header area

HeaderText

specifies the text caption that’s displayed for the header area

Licensed to [email protected]

676

Build Your Own ASP.NET 3.5 Web Site Using C# & VB

NavigationButtonStyle

represents the style properties for the buttons in the navigation area

NavigationStyle

represents the style properties for the navigation area

SideBarButtonStyle

represents the style properties for the buttons on the sidebar

SideBarStyle

represents the style properties for the sidebar area

SideBarTemplate

specifies the template that’s used to display the sidebar area

SkipLinkText

specifies alternative text that notifies screen readers to skip the content in the

sidebar

StartNavigationTemplate

specifies the template that’s used to display the navigation area on the
Start
step

StartNextButtonImageUrl

specifies the URL of the image displayed for the
Next
button on the
Start
step

StartNextButtonStyle

represents the style properties of the
Next
button on the
Start
step

StartNextButtonText

specifies the text for the
Next
button on the
Start
step

StartNextButtonType

specifies the type of button that’s displayed as the
Next
button on the
Start
step; possible values are Button, Image, or Link

StepNavigationTemplate

specifies the template that’s used to display the navigation area on any step

other than the
Start
,
Finish
, or
Complete
step

StepNextButtonImageUrl

specifies the URL of the image displayed for the
Next
button

Licensed to [email protected]

Appendix A: Web Control Reference

677

StepNextButtonStyle

represents the style properties of the
Next
button

StepNextButtonText

specifies the text for the
Next
button

StepNextButtonType

specifies the type of button that’s displayed as the
Next
button; possible values

are Button, Image, or Link

StepPreviousButtonImageUrl

specifies the URL of the image displayed for the
Previous
button

StepPreviousButtonStyle

represents the style properties of the
Previous
button

StepPreviousButtonText

specifies the text for the
Previous
button

StepPreviousButtonType

specifies the type of button that’s displayed as the
Previous
button; possible

values are Button, Image, or Link

StepStyle

represents the style properties of the steps that are defined for the Wizard

WizardSteps

represents the steps that are defined for the Wizard control as a collection of

WizardStepBase objects

Methods

GetHistory

returns all the steps that have already been accessed as a

collection of WizardStepBase objects

GetStepType

returns the WizardStepType value for the specified

WizardStepBase object

MoveTo

sets the ActiveStep property of the Wizard control to the

specified WizardStepBase-derived object

Licensed to [email protected]

678

Build Your Own ASP.NET 3.5 Web Site Using C# & VB

Events

ActiveStepChanged

raised when the user switches to a new step

CancelButtonClick

raised when the
Cancel
button is clicked

FinishButtonClick

raised when the
Finish
button is clicked

NextButtonClick

raised when the
Next
button is clicked

PreviousButtonClick

raised when the
Previous
button is clicked

SideBarButtonClick

raised when a button in the sidebar is clicked

Xml

Properties

Document

specifies the System.Xml.XmlDocument object to display

DocumentContent

specifies a string representing the XML document to display

DocumentSource

specifies the URL of a document to display

Transform

specifies the System.Xml.Xsl.XslTransform object used

to format the XML document

TransformArgumentList

specifies the XsltArgumentList used to format the XML

document

TransformSource

specifies the URL of an XSLT style sheet used to format

the XML document

Validation Controls

The following reference includes a list of important properties, methods, and events

for each of the validation controls. These controls ultimately derive from the

WebControl class, meaning that they, like the web controls themselves, inherit its

properties and methods. The more useful of these properties and methods are listed

at the start of this appendix.

Licensed to [email protected]

Appendix A: Web Control Reference

679

CompareValidator

Properties

ControlToCompare

specifies the ID of the control to use for comparing values

ControlToValidate

specifies the ID of the control that you want to validate

Display

shows how the error message within the validation control

will be displayed; possible values are Static, Dynamic,

and None; default is Static

EnableClientScript

enables or disables client-side validation; by default, is

set to Enabled

Enabled

enables or disables client and server-side validation; default is Enabled

ErrorMessage

specifies the error message that will be displayed to the

user in any associated validation summary control; if no

value is set for the Text property, this message also appears in the control itself

IsValid

has the value True when the validation check succeeds,

and False otherwise

Operator

specifies the operator to use when performing comparisons; possible values are Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, DataTypeCheck

Text

sets the error message displayed by the control when

validation fails

Type

specifies the data type to use when comparing values;

possible values are Currency, Date, Double, Integer, and

String

ValueToCompare

specifies the value used when performing the comparison

Licensed to [email protected]

680

Build Your Own ASP.NET 3.5 Web Site Using C# & VB

Methods

Validate

performs validation and modifies the IsValid property

CustomValidator

ClientValidationFunction

specifies the name of the client-side function to use for validation

ControlToValidate

specifies the ID of the control that you want to validate

Display

shows how the error message within the validation control will be displayed;

possible values are Static, Dynamic, and None; default is Static

EnableClientScript

enables or disables client-side validation; by default, is set as Enabled

Enabled

enables or disables client and server-side validation; by default, is set as Enabled

ErrorMessage

specifies the error message that will be displayed to the user

IsValid

has the value True when the validation check succeeds, and False otherwise

Text

sets the error message displayed by the control when validation fails

Methods

Validate

performs validation and modifies the IsValid property

Events

ServerValidate

represents the function for performing server-side validation

Licensed to [email protected]

Appendix A: Web Control Reference

681

RangeValidator

Properties

ControlToValidate

specifies the ID of the control that you want to validate

Display

shows how the error message within the validation control

will be displayed; possible values are Static, Dynamic,

and None; default is Static

EnableClientScript

enables or disables client-side validation; set as Enabled

by default

Enabled

enables or disables client and server-side validation; set

as Enabled by default

ErrorMessage

specifies the error message that will be displayed to the

user in any associated validation summary control; if no

value is set for the Text property, this message also appears in the control itself

IsValid

has the value True when the validation check succeeds,

and False otherwise

MaximumValue

sets the maximum value in the range of permissible values

MinimumValue

sets the minimum value in the range of permissible values

Text

sets the error message displayed by the control when

validation fails

Type

specifies the data type to use when comparing values;

possible values are Currency, Date, Double, Integer, and

String

Methods

Validate

performs validation and modifies the IsValid property

Licensed to [email protected]

682

Build Your Own ASP.NET 3.5 Web Site Using C# & VB

RegularExpressionValidator

Properties

ControlToValidate

specifies the ID of the control that you want to validate

Display

shows how the error message within the validation control

will be displayed; possible values are Static, Dynamic,

and None; default is Static

EnableClientScript

enables or disables client-side validation; set as Enabled

by default

Enabled

enables or disables client and server-side validation; by

default, is set as Enabled

ErrorMessage

specifies the error message that will be displayed to the

user

InitialValue

specifies the initial value specified by the

ControlToValidate property

IsValid

has the value True when the validation check succeeds,

and False otherwise

Text

sets the error message displayed by the control

ValidateExpression

specifies the regular expression to use when performing

validation

Methods

Validate

performs validation and modifies the IsValid property

RequiredFieldValidator

Properties

ControlToValidate

specifies the ID of the control that you want to validate

Licensed to [email protected]

Appendix A: Web Control Reference

683

Display

shows how the error message within the validation control

will be displayed; possible values are Static, Dynamic,

and None; default is Static

EnableClientScript

enables or disables client-side validation; set as Enabled

by default

Enabled

enables or disables client and server-side validation; by

default, it is enabled

ErrorMessage

specifies the error message that will be displayed to the

user in any associated validation summary control; if no

value is set for the Text property, this message also appears in the control itself

InitialValue

specifies the initial value specified by the

ControlToValidate property

IsValid

has the value True when the validation check succeeds,

and False otherwise

Text

sets the error message displayed by the control when

validation fails

Methods

Validate

performs validation and modifies the IsValid property

ValidationSummary

Properties

DisplayMode

sets the formatting for the error messages that are displayed within the page; possible values are BulletList, List, and SingleParagraph; these messages are the

ErrorMessage properties of all validation controls for

which validation has failed

EnableClientScript

enables or disables client-side validation; by default, is

set as Enabled

Licensed to [email protected]

684

Build Your Own ASP.NET 3.5 Web Site Using C# & VB

Enabled

enables or disables client and server-side validation; by

default, is set as Enabled

HeaderText

sets the text that is displayed to the user at the top of the

summary

ShowMessageBox

when the value is set to True, an alert box listing form

fields that caused errors is presented to the user

ShowSummary