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

enables or disables the summary of error messages

Navigation Web Controls

SiteMapPath

Properties

CurrentNodeStyle

the style used to display the current node

CurrentNodeTemplate

the template used to display the current node

NodeStyle

the style used to display SiteMapPath nodes

NodeTemplate

the template used to display nodes

ParentLevelsDisplayed

the maximum number of parent nodes to display

PathDirection

specifies the path direction display; possible values are

PathDirection.CurrentToRoot and

PathDirection.RootToCurrent

PathSeparator

the string used to separate path nodes

PathSeparatorStyle

the styles used to display the path separator

PathSeparatorTemplate

the template used to display the separator

Provider

the SiteMapProvider object associated with the

SiteMapPath; the default site map provider is

XmlSiteMapProvider, which reads its data from the

Web.sitemap
file

Licensed to [email protected]

Appendix A: Web Control Reference

685

RenderCurrentNodeAsLink

when set to True, the current site map site will be displayed as a link; default value is False
RootNodeStyle

the style used to display the root node

RootNodeTemplate

the template used to display the root node

ShowToolTips

specifies whether the node links should display tooltips

when the cursor hovers over them

SiteMapProvider

a string representing the name of the SiteMapProvider

object associated with the SiteMapPath

SkipLinkText

a string that describes a link to allow screen reader users

to skip the control’s content

Methods

DataBind

binds the SiteMapPath to its data source

Events

ItemCreated

fires when a new SiteMapNodeItem object is created

ItemDataBound

fires after a node item has been bound to the data source

Menu

Properties

Controls

returns a ControlColection object containing the menu’s child controls

DisappearAfter

an integer representing how long, in milliseconds, a dynamic menu continues

to display after the cursor ceases to hover over it; the default is 500; when

DisappearAfter is set to -1, the menu won’t disappear automatically

Licensed to [email protected]

686

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

DynamicBottomSeparatorImageUrl

a string representing the URL of an image to be displayed at the bottom of a

dynamic menu item; this is usually a line that separates the dynamic item from

the other items; value is empty (an empty string) by default

DynamicEnableDefaultPopOutImage

a Boolean value representing whether a dynamic menu that contains a submenu

should be enhanced with the image specified by DynamicPopOutImageUrl; default

value is True

DynamicHorizontalOffset

an integer representing the number of pixels by which a dynamic menu should

be shifted horizontally relative to the parent menu item

DynamicHoverStyle

a MenuItemStyle object that allows you to control the appearance of a dynamic

menu item when the cursor hovers over it

DynamicItemFormatString

a string used to set the text to be displayed for dynamic menu items on mobile

devices that don’t support templates

DynamicItemTemplate

the template to be used to render dynamic menu items

DynamicMenuItemStyle

the MenuItemStyle object that represents the styles used to render dynamic

menu items

DynamicMenuStyle

the SubMenuStyle object that represents the styles used for rendering the dynamic

menu

DynamicPopOutImageTextFormatString

a string representing the alternate text to be displayed instead of the image

specified by DynamicPopOutImageUrl

DynamicPopOutImageUrl

a string representing the URL for the image to be displayed for a dynamic menu

item that has a submenu when DynamicEnableDefaultPopOutImage is True

Licensed to [email protected]

Appendix A: Web Control Reference

687

DynamicSelectedStyle

a MenuItemStyle object representing the style of a selected dynamic menu item

DynamicTopSeparatorImageUrl

a string representing the URL for an image to be displayed at the top of a dynamic

menu item; this is usually a line that separates the dynamic item from the other

items; the value is empty (an empty string) by default

DynamicVerticalOffset

an integer representing the number of pixels by which a dynamic menu should

be shifted vertically relative to the parent menu item

Items

a MenuItemCollection that contains a collection of MenuItem objects, representing all the menu items
ItemWrap

a Boolean value representing whether the menu items’ text should wrap

LevelMenuItemStyles

a MenuItemStyleCollection representing a collection of MenuItemStyle objects

that define the styles to be applied to menu items depending on their levels in

the menu (the first object in the collection defines the style for the first menu

level, the second object in the collection defines the style for the second menu

level, and so on)

LevelSelectedStyles

similar to LevelMenuItemStyles, but applies to selected menu items

LevelSubMenuStyles

similar to LevelMenuItemStyles, but applies to submenu items

MaximumDynamicDisplayLevels

an integer that specifies the maximum number of dynamic menu levels to display; the default value is 3

Orientation

can be set either to Orientation.Horizontal or Orientation.Vertical, specifying the direction in which to display the menu items Licensed to [email protected]

688

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

PathSeparator

a Char value representing the character used to delimit the path of a menu item

ScrollDownImageUrl

a string representing the URL for an image to be displayed in a dynamic menu

to indicate that the user can scroll down to see more menu items

ScrollDownText

alternate text for the image defined by ScrollDownImageUrl

ScrollUpImageUrl

a string representing the URL for an image to be displayed in a dynamic menu

to indicate that the user can scroll up to see more menu items

ScrollUpText

alternate text for the image defined by ScrollUpImageUrl

SelectedItem

a MenuItem object representing the selected menu item

SelectedValue

a string representing the text of the selected menu item

SkipLinkText

a string representing alternate text to be used by screen readers to allow screen

reader users to skip the list of links

StaticBottomSeparatorImageUrl

a string representing the URL for an image to be displayed at the bottom of a

static menu item—usually a line that separates the static item from the other

items; value is empty (an empty string), by default

StaticDisplayLevels

an integer representing the maximum number of levels to display for a static

menu; default is 1

StaticEnableDefaultPopOutImage

a Boolean value representing whether a static menu that contains a submenu

should be enhanced with the image specified by StaticPopOutImageUrl; default

is True

Licensed to [email protected]

Appendix A: Web Control Reference

689

StaticHoverStyle

a MenuItemStyle object that allows you to control the appearance of a static

menu item when the cursor is hovered over it

StaticItemFormatString

a string used to set the text for static menu items displayed on mobile devices

that don’t support templates

StaticItemTemplate

the template to be used to render static menu items

StaticMenuItemStyle

the MenuItemStyle object that represents the styles used to render static menu

items

StaticMenuStyle

the SubMenuStyle object that represents the styles used to render the static menu

StaticPopOutImageTextFormatString

a string representing the alternative text to be displayed instead of the image

specified by StaticPopOutImageUrl

StaticPopOutImageUrl

a string representing the URL for the image to be displayed for a dynamic menu

item that has a submenu, when StaticEnableDefaultPopOutImage is True

StaticSelectedStyle

a MenuItemStyle object representing the style of a selected static menu item

StaticSubMenuIndent

a Unit value representing the number of pixels by which submenus should be

indented in a static menu

StaticTopSeparatorImageUrl

a string representing the URL for an image to be displayed at the top of a static

menu item; this is usually a line that separates the static item from the other

items; value is empty (an empty string) by default

Licensed to [email protected]

690

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

Target

specifies the target window or frame in which content associated with a menu

item should be displayed when the item is clicked; possible values are _blank,

_parent, _search, _self, and _top

Methods

DataBind

binds the menu to its data source

FindItem

returns the MenuItem located at the path specified by the

valuePath
string parameter; that path must also contain

the path separator, which is retrieved through the

PathSeparator property

Events

MenuItemClick

fired when a menu item is clicked

MenuItemDataBound

fired when a menu item is bound to its data source

TreeView

Properties

AutoGenerateDataBindings

a Boolean value specifying whether the TreeView should automatically generate

tree node bindings; default is True

CheckedNodes

a collection of TreeNode objects representing the checked TreeView nodes

CollapseImageToolTip

the tooltip for the image displayed for the “collapse” node indicator

CollapseImageUrl

a string representing the URL for a custom image to be used as the “collapse”

node indicator

Licensed to [email protected]

Appendix A: Web Control Reference

691

EnableClientScript

a Boolean value that specifies whether or not the TreeView should generate

client-side JavaScript that expands or collapses nodes; True by default; when

the value is False, a server postback needs to be performed every time the user

expands or collapses a node

ExpandDepth

an integer representing the number of TreeView levels that are expanded when

the control is displayed for the first time; default is -1, which displays all the

nodes

ExpandImageToolTip

the tooltip for the image displayed for the “expand” node indicator

ExpandImageUrl

a string representing the URL for a custom image to be used as the “expand”

node indicator

HoverNodeStyle

a TreeNodeStyle object used to define the styles of a node when the cursor is

hovered over it

ImageSet

a TreeViewImageSet value representing the set of images to be used when displaying TreeView nodes; default values are Arrows, BulletedList, BulletedList2, BulletedList3, BulletedList4, Contacts, Custom, Events, Faq, Inbox, News, Simple, Simple2, Msdn, WindowsHelp, and XPFileExplorer; when not

using one of these predefined sets, you should define these properties instead:

CollapseImageUrl, ExpandImageUrl, LineImagesFolder, and NoExpandImageUrl

LeafNodeStyle

a TreeNodeStyle representing the style used to render leaf nodes

LevelStyles

a TreeNodeStyleCollection that contains the styles used to render the items

in each TreeView level

Licensed to [email protected]

692

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

LineImagesFolder

a string containing the path to a web-accessible folder that holds the image files

used to connect child nodes to parent nodes; that folder must include these

files:
Dash.gif
,
Dashminus.gif
,
Dashplus.gif
,
I.gif
,
L.gif
,
Lminus.gif
,
Lplus.gif
,
Minus.gif
,
Noexpand.gif
,
Plus.gif
,
R.gif
,
Rminus.gif
,
Rplus.gif
,
T.gif
,
Tminus.gif
, and
Tplus.gif
MaxDataBindDepth

defines the maximum number of tree levels to bind to the TreeView control

NodeIndent

an integer representing the number of pixels by which child nodes in the tree

will be indented

Nodes