SiteMapPath Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Отображает набор гиперссылок текста или изображения, которые позволяют пользователям проще перемещаться по веб-сайту, принимая минимальное количество пространства страницы.
public ref class SiteMapPath : System::Web::UI::WebControls::CompositeControl
public class SiteMapPath : System.Web.UI.WebControls.CompositeControl
type SiteMapPath = class
inherit CompositeControl
Public Class SiteMapPath
Inherits CompositeControl
- Наследование
Примеры
В следующем примере кода элемент управления декларативно используется SiteMapPath на странице веб-форм. В этом примере демонстрируются некоторые правила приоритета, которые управляют порядком применения шаблонов и стилей к SiteMapPath узлам.
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<!-- The following example demonstrates some of the orders
of precedence when applying styles and templates to
functional nodes of a SiteMapPath.
The NodeStyle and RootNodeStyle define the same attributes,
but are different and conflict with each other: the
RootNodeStyle supersedes NodeStyle, and is the style
rendered. Notice, however, that the underline style
defined by NodeStyle is still applied.
Both a CurrentNodeStyle and a CurrentNodeTemplate are
defined. A template supersedes a style for a node
type, so CurrentNodeTemplate is displayed and CurrentNodeStyle
is ignored. -->
<asp:SiteMapPath ID="SiteMapPath1" runat="server"
RenderCurrentNodeAsLink="true"
NodeStyle-Font-Names="Franklin Gothic Medium"
NodeStyle-Font-Underline="true"
NodeStyle-Font-Bold="true"
RootNodeStyle-Font-Names="Symbol"
RootNodeStyle-Font-Bold="false"
CurrentNodeStyle-Font-Names="Verdana"
CurrentNodeStyle-Font-Size="10pt"
CurrentNodeStyle-Font-Bold="true"
CurrentNodeStyle-ForeColor="red"
CurrentNodeStyle-Font-Underline="false">
<CURRENTNODETEMPLATE>
<asp:Image id="Image1" runat="server" ImageUrl="WebForm2.jpg" AlternateText="WebForm2"/>
</CURRENTNODETEMPLATE>
</asp:SiteMapPath>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<!-- The following example demonstrates some of the orders
of precedence when applying styles and templates to
functional nodes of a SiteMapPath.
The NodeStyle and RootNodeStyle define the same attributes,
but are different and conflict with each other: the
RootNodeStyle supersedes NodeStyle, and is the style
rendered. Notice, however, that the underline style
defined by NodeStyle is still applied.
Both a CurrentNodeStyle and a CurrentNodeTemplate are
defined. A template supersedes a style for a node
type, so CurrentNodeTemplate is displayed and CurrentNodeStyle
is ignored. -->
<asp:SiteMapPath ID="SiteMapPath1" runat="server"
RenderCurrentNodeAsLink="true"
NodeStyle-Font-Names="Franklin Gothic Medium"
NodeStyle-Font-Underline="true"
NodeStyle-Font-Bold="true"
RootNodeStyle-Font-Names="Symbol"
RootNodeStyle-Font-Bold="false"
CurrentNodeStyle-Font-Names="Verdana"
CurrentNodeStyle-Font-Size="10pt"
CurrentNodeStyle-Font-Bold="true"
CurrentNodeStyle-ForeColor="red"
CurrentNodeStyle-Font-Underline="false">
<CURRENTNODETEMPLATE>
<asp:Image id="Image1" runat="server" ImageUrl="WebForm2.jpg" AlternateText="WebForm2"/>
</CURRENTNODETEMPLATE>
</asp:SiteMapPath>
</form>
</body>
</html>
В предыдущем примере используется поставщик карты сайта по умолчанию и файл web.sitemap со следующей структурой.
<siteMap>
<siteMapNode title="WebForm1" description="WebForm1" url="WebForm1.aspx" >
<siteMapNode title="WebForm2" description="WebForm2" url="WebForm2.aspx"/>
</siteMapNode>
</siteMap>
В следующем примере кода демонстрируется расширение SiteMapPath элемента управления и добавление в него новых функциональных возможностей InitializeItem путем переопределения метода. Элемент DropDownSiteMapPath управления добавляет DropDownList после текущего узла, чтобы упростить навигацию на страницы, которые являются дочерними узлами текущей страницы. В этом примере показано, как работать с SiteMapNodeItem объектами, включая проверку их SiteMapNodeItemType и вызов OnItemCreated метода после создания элементов.
using System;
using System.Collections;
using System.ComponentModel;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
// The DropDownNavigationPath is a class that extends the SiteMapPath
// control and renders a DropDownList after the CurrentNode. The
// DropDownList displays a list of pages found further down the site map
// hierarchy from the current one. Selecting an item in the DropDownList
// redirects to that page.
//
// For simplicity, the DropDownNavigationPath assumes the
// RootToCurrent PathDirection, and does not apply styles
// or templates the current node.
//
[AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
public class DropDownNavigationPath : SiteMapPath {
// Override the InitializeItem method to add a PathSeparator
// and DropDownList to the current node.
protected override void InitializeItem(SiteMapNodeItem item) {
// The only node that must be handled is the CurrentNode.
if (item.ItemType == SiteMapNodeItemType.Current)
{
HyperLink hLink = new HyperLink();
// No Theming for the HyperLink.
hLink.EnableTheming = false;
// Enable the link of the SiteMapPath is enabled.
hLink.Enabled = this.Enabled;
// Set the properties of the HyperLink to
// match those of the corresponding SiteMapNode.
hLink.NavigateUrl = item.SiteMapNode.Url;
hLink.Text = item.SiteMapNode.Title;
if (ShowToolTips) {
hLink.ToolTip = item.SiteMapNode.Description;
}
// Apply styles or templates to the HyperLink here.
// ...
// ...
// Add the item to the Controls collection.
item.Controls.Add(hLink);
AddDropDownListAfterCurrentNode(item);
}
else {
base.InitializeItem(item);
}
}
private void AddDropDownListAfterCurrentNode(SiteMapNodeItem item) {
SiteMapNodeCollection childNodes = item.SiteMapNode.ChildNodes;
// Only do this work if there are child nodes.
if (childNodes != null) {
// Add another PathSeparator after the CurrentNode.
SiteMapNodeItem finalSeparator =
new SiteMapNodeItem(item.ItemIndex,
SiteMapNodeItemType.PathSeparator);
SiteMapNodeItemEventArgs eventArgs =
new SiteMapNodeItemEventArgs(finalSeparator);
InitializeItem(finalSeparator);
// Call OnItemCreated every time a SiteMapNodeItem is
// created and initialized.
OnItemCreated(eventArgs);
// The pathSeparator does not bind to any SiteMapNode, so
// do not call DataBind on the SiteMapNodeItem.
item.Controls.Add(finalSeparator);
// Create a DropDownList and populate it with the children of the
// CurrentNode. There are no styles or templates that are applied
// to the DropDownList control. If OnSelectedIndexChanged is raised,
// the event handler redirects to the page selected.
// The CurrentNode has child nodes.
DropDownList ddList = new DropDownList();
ddList.AutoPostBack = true;
ddList.SelectedIndexChanged += new EventHandler(this.DropDownNavPathEventHandler);
// Add a ListItem to the DropDownList for every node in the
// SiteMapNodes collection.
foreach (SiteMapNode node in childNodes) {
ddList.Items.Add(new ListItem(node.Title, node.Url));
}
item.Controls.Add(ddList);
}
}
// The sender is the DropDownList.
private void DropDownNavPathEventHandler(object sender,EventArgs e) {
DropDownList ddL = sender as DropDownList;
// Redirect to the page the user chose.
if (Context != null)
Context.Response.Redirect(ddL.SelectedValue);
}
}
Imports System.Collections
Imports System.ComponentModel
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace Samples.AspNet
' The DropDownNavigationPath is a class that extends the SiteMapPath
' control and renders a DropDownList after the CurrentNode. The
' DropDownList displays a list of pages found further down the site map
' hierarchy from the current one. Selecting an item in the DropDownList
' redirects to that page.
'
' For simplicity, the DropDownNavigationPath assumes the
' RootToCurrent PathDirection, and does not apply styles
' or templates the current node.
'
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class DropDownNavigationPath
Inherits SiteMapPath
' Override the InitializeItem method to add a PathSeparator
' and DropDownList to the current node.
Protected Overrides Sub InitializeItem(item As SiteMapNodeItem)
' The only node that must be handled is the CurrentNode.
If item.ItemType = SiteMapNodeItemType.Current Then
Dim hLink As New HyperLink()
' No Theming for the HyperLink.
hLink.EnableTheming = False
' Enable the link of the SiteMapPath is enabled.
hLink.Enabled = Me.Enabled
' Set the properties of the HyperLink to
' match those of the corresponding SiteMapNode.
hLink.NavigateUrl = item.SiteMapNode.Url
hLink.Text = item.SiteMapNode.Title
If ShowToolTips Then
hLink.ToolTip = item.SiteMapNode.Description
End If
' Apply styles or templates to the HyperLink here.
' ...
' ...
' Add the item to the Controls collection.
item.Controls.Add(hLink)
AddDropDownListAfterCurrentNode(item)
Else
MyBase.InitializeItem(item)
End If
End Sub
Private Sub AddDropDownListAfterCurrentNode(item As SiteMapNodeItem)
Dim childNodes As SiteMapNodeCollection = item.SiteMapNode.ChildNodes
' Only do this work if there are child nodes.
If Not (childNodes Is Nothing) Then
' Add another PathSeparator after the CurrentNode.
Dim finalSeparator As New SiteMapNodeItem(item.ItemIndex, SiteMapNodeItemType.PathSeparator)
Dim eventArgs As New SiteMapNodeItemEventArgs(finalSeparator)
InitializeItem(finalSeparator)
' Call OnItemCreated every time a SiteMapNodeItem is
' created and initialized.
OnItemCreated(eventArgs)
' The pathSeparator does not bind to any SiteMapNode, so
' do not call DataBind on the SiteMapNodeItem.
item.Controls.Add(finalSeparator)
' Create a DropDownList and populate it with the children of the
' CurrentNode. There are no styles or templates that are applied
' to the DropDownList control. If OnSelectedIndexChanged is raised,
' the event handler redirects to the page selected.
' The CurrentNode has child nodes.
Dim ddList As New DropDownList()
ddList.AutoPostBack = True
AddHandler ddList.SelectedIndexChanged, AddressOf Me.DropDownNavPathEventHandler
' Add a ListItem to the DropDownList for every node in the
' SiteMapNodes collection.
Dim node As SiteMapNode
For Each node In childNodes
ddList.Items.Add(New ListItem(node.Title, node.Url))
Next node
item.Controls.Add(ddList)
End If
End Sub
' The sender is the DropDownList.
Private Sub DropDownNavPathEventHandler(sender As Object, e As EventArgs)
Dim ddL As DropDownList = CType(sender, DropDownList)
' Redirect to the page the user chose.
If Not (Context Is Nothing) Then
Context.Response.Redirect(ddL.SelectedValue)
End If
End Sub
End Class
End Namespace
Комментарии
В этом разделе:
Введение
Элемент SiteMapPath управления — это элемент управления навигацией сайта, который отражает данные, предоставляемые SiteMap объектом. Он предоставляет способ экономии места для упрощения навигации по сайту и служит точкой ссылки на то, где в настоящее время отображается страница в пределах сайта. Этот тип элемента управления обычно называется панелью навигации или бровью, так как он отображает иерархический путь гиперссылок имен страниц, который обеспечивает экранирование иерархии страниц из текущего расположения. SiteMapDataSource. Это SiteMapPath полезно для сайтов, имеющих глубокие иерархические структуры страниц, но где MenuTreeView или может потребоваться слишком много места на странице.
Элемент SiteMapPath управления работает непосредственно с данными карты сайта веб-сайта. Если вы используете его на странице, которая не представлена на карте сайта, она не будет отображаться. Дополнительные сведения о картах сайтов см. в разделе ASP.NET Навигация по сайту.
Nodes
Состоит SiteMapPath из узлов. Каждый элемент в пути называется узлом и представлен SiteMapNodeItem объектом. Узел, который привязывает путь и представляет основу иерархического дерева, называется корневым узлом. Узел, представляющий отображаемую в данный момент страницу, является текущим узлом. Любой другой узел между текущим узлом и корневым узлом является родительским узлом. В следующей таблице описаны три различных типа узлов.
| Тип узла | Описание |
|---|---|
| корень | Узел, который привязывает иерархический набор узлов. |
| parent | Узел, имеющий один или несколько дочерних узлов, но не текущий. |
| текущий | Узел, представляющий текущую отображаемую страницу. |
Внешний вид узла
Каждый узел, отображаемый элементом управления SiteMapPath , является HyperLink элементом Literal управления, к которому можно применить шаблон или стиль. Шаблоны и стили применяются к узлам в соответствии с двумя правилами приоритета:
Если шаблон определен для узла, он переопределяет любой стиль, определенный для узла.
Шаблоны и стили, относящиеся к типам узлов, переопределяют общие шаблоны и стили, определенные для всех узлов.
NodeTemplate Свойства NodeStyle применяются ко всем узлам независимо от их типа. Если определены оба этих свойства, NodeTemplate приоритет имеет приоритет.
CurrentNodeStyle Свойства CurrentNodeTemplate применяются к узлам, представляющим текущую отображаемую страницу. Если он NodeTemplate определен в дополнение к параметру CurrentNodeTemplate, он игнорируется. Если он NodeStyle определен в дополнение CurrentNodeStyleк объекту, он объединяется с CurrentNodeStyle созданием объединенного стиля. Этот объединенный стиль использует все элементы CurrentNodeStyle, а также любые дополнительные элементы NodeStyle , которые не конфликтуют с CurrentNodeStyle.
RootNodeStyle Свойства RootNodeTemplate применяются к узлу, представляющего корень иерархии навигации сайта. Если он NodeTemplate определен в дополнение к параметру RootNodeTemplate, он игнорируется. Если он NodeStyle определен в дополнение RootNodeStyleк объекту, он объединяется с RootNodeStyle созданием объединенного стиля. Этот объединенный стиль использует все элементы RootNodeStyleэлемента , а также любые дополнительные элементы NodeStyle , которые не конфликтуют с CurrentNodeStyle. Наконец, если отображаемая в данный момент страница является корневой страницей сайта, RootNodeTemplate она RootNodeStyle используется вместо CurrentNodeTemplate или CurrentNodeStyle.
Элемент SiteMapPath управления использует поставщика карты сайта, определяемого SiteMapProvider свойством в качестве источника данных для сведений о навигации сайта. Если поставщик не указан, он использует поставщик по умолчанию для сайта, определенный в свойстве SiteMap.Provider . Как правило, это экземпляр поставщика карты сайта по умолчанию для ASP.NET.XmlSiteMapProvider Если элемент SiteMapPath управления используется на сайте, но поставщик карты сайта не настроен, элемент управления создает HttpException исключение.
События
Элемент SiteMapPath управления также предоставляет события, которые можно программовать. Это позволяет запускать пользовательскую подпрограмму всякий раз, когда происходит событие. В следующей таблице перечислены события, поддерживаемые элементом SiteMapPath управления.
| Event | Описание |
|---|---|
| ItemCreated | Происходит, когда SiteMapPath элемент управления сначала создает SiteMapNodeItem и связывает его с элементом SiteMapNodeуправления. |
| ItemDataBound | Происходит при SiteMapNodeItem привязке к данным карты сайта, содержащимся в объекте SiteMapNode. |
Настройка элемента управления SiteMapPath
Классы, производные от SiteMapPath переопределения InitializeItem метода, чтобы настроить SiteMapNodeItem элементы управления, содержащиеся в элементе управления навигации. Для полного управления способом SiteMapNodeItem создания и добавления объектов в SiteMapPathпроизводные классы переопределяют CreateControlHierarchy метод.
Доступность
Сведения о настройке этого элемента управления таким образом, чтобы он создавал разметку, соответствующую стандартам специальных возможностей, см. в разделе "Специальные возможности" в Visual Studio и ASP.NET и ASP.NET элементы управления и специальные возможности.
Декларативный синтаксис
<asp:SiteMapPath
AccessKey="string"
BackColor="color name|#dddddd"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
Inset|Outset"
BorderWidth="size"
CssClass="string"
Enabled="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
Height="size"
ID="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnItemCreated="ItemCreated event handler"
OnItemDataBound="ItemDataBound event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
ParentLevelsDisplayed="integer"
PathDirection="RootToCurrent|CurrentToRoot"
PathSeparator="string"
RenderCurrentNodeAsLink="True|False"
runat="server"
ShowToolTips="True|False"
SiteMapProvider="string"
SkinID="string"
SkipLinkText="string"
Style="string"
TabIndex="integer"
ToolTip="string"
Visible="True|False"
Width="size"
>
<CurrentNodeStyle />
<CurrentNodeTemplate>
<!-- child controls -->
</CurrentNodeTemplate>
<NodeStyle />
<NodeTemplate>
<!-- child controls -->
</NodeTemplate>
<PathSeparatorStyle />
<PathSeparatorTemplate>
<!-- child controls -->
</PathSeparatorTemplate>
<RootNodeStyle />
<RootNodeTemplate>
<!-- child controls -->
</RootNodeTemplate>
</asp:SiteMapPath>
Конструкторы
| Имя | Описание |
|---|---|
| SiteMapPath() |
Инициализирует новый экземпляр класса SiteMapPath. |
Свойства
| Имя | Описание |
|---|---|
| AccessKey |
Возвращает или задает ключ доступа, позволяющий быстро перейти к элементу управления веб-сервера. (Унаследовано от WebControl) |
| Adapter |
Возвращает адаптер, зависящий от браузера, для элемента управления. (Унаследовано от Control) |
| AppRelativeTemplateSourceDirectory |
Возвращает или задает относительный к приложению виртуальный каталог Page объекта или UserControl объекта, содержащего этот элемент управления. (Унаследовано от Control) |
| Attributes |
Возвращает коллекцию произвольных атрибутов (только для отрисовки), которые не соответствуют свойствам элемента управления. (Унаследовано от WebControl) |
| BackColor |
Возвращает или задает цвет фона элемента управления веб-сервера. (Унаследовано от WebControl) |
| BindingContainer |
Возвращает элемент управления, содержащий привязку данных этого элемента управления. (Унаследовано от Control) |
| BorderColor |
Возвращает или задает цвет границы веб-элемента управления. (Унаследовано от WebControl) |
| BorderStyle |
Возвращает или задает стиль границы элемента управления веб-сервера. (Унаследовано от WebControl) |
| BorderWidth |
Возвращает или задает ширину границы элемента управления веб-сервера. (Унаследовано от WebControl) |
| ChildControlsCreated |
Возвращает значение, указывающее, были ли созданы дочерние элементы управления сервера. (Унаследовано от Control) |
| ClientID |
Возвращает идентификатор элемента управления для разметки HTML, созданной ASP.NET. (Унаследовано от Control) |
| ClientIDMode |
Возвращает или задает алгоритм, используемый для создания значения ClientID свойства. (Унаследовано от Control) |
| ClientIDSeparator |
Возвращает значение символа, представляющее символ разделителя, используемый в свойстве ClientID . (Унаследовано от Control) |
| Context |
HttpContext Возвращает объект, связанный с серверным элементом управления для текущего веб-запроса. (Унаследовано от Control) |
| Controls |
ControlCollection Возвращает объект, представляющий дочерние элементы управления в объекте CompositeControl. (Унаследовано от CompositeControl) |
| ControlStyle |
Возвращает стиль элемента управления веб-сервера. Это свойство используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| ControlStyleCreated |
Возвращает значение, указывающее, был ли Style объект создан для ControlStyle свойства. Это свойство в основном используется разработчиками элементов управления. (Унаследовано от WebControl) |
| CssClass |
Возвращает или задает класс каскадной таблицы стилей (CSS), отображаемый элементом управления веб-сервера на клиенте. (Унаследовано от WebControl) |
| CurrentNodeStyle |
Возвращает стиль, используемый для отображаемого текста для текущего узла. |
| CurrentNodeTemplate |
Возвращает или задает шаблон элемента управления, используемый для узла пути навигации сайта, представляющего текущую отображаемую страницу. |
| DataItemContainer |
Возвращает ссылку на контейнер именования, если контейнер именования реализует IDataItemContainer. (Унаследовано от Control) |
| DataKeysContainer |
Возвращает ссылку на контейнер именования, если контейнер именования реализует IDataKeysControl. (Унаследовано от Control) |
| DesignMode |
Возвращает значение, указывающее, используется ли элемент управления на поверхности конструктора. (Унаследовано от Control) |
| Enabled |
Возвращает или задает значение, указывающее, включен ли элемент управления веб-сервера. (Унаследовано от WebControl) |
| EnableTheming |
Возвращает или задает значение, указывающее, применяются ли темы к этому элементу управления. (Унаследовано от WebControl) |
| EnableViewState |
Возвращает или задает значение, указывающее, сохраняет ли серверный элемент управления состояние представления и состояние представления всех дочерних элементов управления, содержащихся в нем, для запрашивающего клиента. (Унаследовано от Control) |
| Events |
Возвращает список делегатов обработчика событий для элемента управления. Это свойство доступно только для чтения. (Унаследовано от Control) |
| Font |
Возвращает свойства шрифта, связанные с элементом управления веб-сервера. (Унаследовано от WebControl) |
| ForeColor |
Возвращает или задает цвет переднего плана (обычно цвет текста) элемента управления веб-сервера. (Унаследовано от WebControl) |
| HasAttributes |
Возвращает значение, указывающее, имеет ли элемент управления набор атрибутов. (Унаследовано от WebControl) |
| HasChildViewState |
Получает значение, указывающее, имеют ли дочерние элементы управления текущего элемента управления серверным элементом управления какие-либо сохраненные параметры состояния представления. (Унаследовано от Control) |
| Height |
Возвращает или задает высоту элемента управления веб-сервера. (Унаследовано от WebControl) |
| ID |
Возвращает или задает программный идентификатор, назначенный элементу управления сервером. (Унаследовано от Control) |
| IdSeparator |
Возвращает символ, используемый для разделения идентификаторов элемента управления. (Унаследовано от Control) |
| IsChildControlStateCleared |
Возвращает значение, указывающее, имеют ли элементы управления, содержащиеся в этом элементе управления, состояние элемента управления. (Унаследовано от Control) |
| IsEnabled |
Возвращает значение, указывающее, включен ли элемент управления. (Унаследовано от WebControl) |
| IsTrackingViewState |
Возвращает значение, указывающее, сохраняется ли серверная система управления изменениями в состоянии представления. (Унаследовано от Control) |
| IsViewStateEnabled |
Возвращает значение, указывающее, включено ли состояние представления для этого элемента управления. (Унаследовано от Control) |
| LoadViewStateByID |
Возвращает значение, указывающее, участвует ли элемент управления в загрузке состояния ID представления вместо индекса. (Унаследовано от Control) |
| NamingContainer |
Возвращает ссылку на контейнер именования серверного элемента управления, который создает уникальное пространство имен для различения между элементами управления сервера с ID одинаковым значением свойства. (Унаследовано от Control) |
| NodeStyle |
Возвращает стиль, используемый для отображения текста для всех узлов в пути навигации сайта. |
| NodeTemplate |
Возвращает или задает шаблон элемента управления, используемый для всех функциональных узлов пути навигации сайта. |
| Page |
Возвращает ссылку на Page экземпляр, содержащий серверный элемент управления. (Унаследовано от Control) |
| Parent |
Возвращает ссылку на родительский элемент управления сервера в иерархии элементов управления страницами. (Унаследовано от Control) |
| ParentLevelsDisplayed |
Возвращает или задает количество уровней родительских узлов, отображаемых элементом управления, относительно текущего отображаемого узла. |
| PathDirection |
Возвращает или задает порядок отрисовки узлов пути навигации. |
| PathSeparator |
Возвращает или задает строку, разделяющую SiteMapPath узлы в отрисованном пути навигации. |
| PathSeparatorStyle |
Возвращает стиль, используемый PathSeparator для строки. |
| PathSeparatorTemplate |
Возвращает или задает шаблон элемента управления, используемый для разделителя путей пути навигации сайта. |
| Provider |
Возвращает или задает объект, связанный SiteMapProvider с элементом управления веб-сервера. |
| RenderCurrentNodeAsLink |
Указывает, отображается ли узел навигации сайта, представляющий отображаемую в данный момент страницу в виде гиперссылки. |
| RenderingCompatibility |
Возвращает значение, указывающее версию ASP.NET, с которым будет совместим отрисованный HTML. (Унаследовано от Control) |
| RootNodeStyle |
Возвращает стиль для отображаемого текста корневого узла. |
| RootNodeTemplate |
Возвращает или задает шаблон элемента управления, используемый для корневого узла пути навигации сайта. |
| ShowToolTips |
Возвращает или задает значение, указывающее, записывает ли SiteMapPath элемент управления дополнительный атрибут гиперссылки для гиперссылок узлов навигации. В зависимости от поддержки клиентов при наведении указателя мыши на гиперссылку с дополнительным набором атрибутов отображается подсказка. |
| Site |
Получает сведения о контейнере, на котором размещается текущий элемент управления при отрисовки на поверхности конструктора. (Унаследовано от Control) |
| SiteMapProvider |
Возвращает или задает имя используемого SiteMapProvider для отрисовки элемента управления навигацией сайта. |
| SkinID |
Возвращает или задает кожу, применяемую к элементу управления. (Унаследовано от WebControl) |
| SkipLinkText |
Возвращает или задает значение, используемое для отображения альтернативного текста для средств чтения с экрана, чтобы пропустить содержимое элемента управления. |
| Style |
Возвращает коллекцию текстовых атрибутов, которые будут отображаться как атрибут стиля во внешнем теге элемента управления веб-сервера. (Унаследовано от WebControl) |
| SupportsDisabledAttribute |
Возвращает значение, указывающее, должен ли элемент управления задать |
| TabIndex |
Возвращает или задает индекс табуляции элемента управления веб-сервера. (Унаследовано от WebControl) |
| TagKey |
Возвращает значение, соответствующее HtmlTextWriterTag этому элементу управления веб-сервера. Это свойство используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| TagName |
Возвращает имя тега элемента управления. Это свойство используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| TemplateControl |
Возвращает или задает ссылку на шаблон, содержащий этот элемент управления. (Унаследовано от Control) |
| TemplateSourceDirectory |
Возвращает виртуальный Page каталог или UserControl содержащий текущий серверный элемент управления. (Унаследовано от Control) |
| ToolTip |
Возвращает или задает текст, отображаемый при наведении указателя мыши на элемент управления веб-сервера. (Унаследовано от WebControl) |
| UniqueID |
Возвращает уникальный иерархический идентификатор для элемента управления сервером. (Унаследовано от Control) |
| ValidateRequestMode |
Возвращает или задает значение, указывающее, проверяет ли элемент управления входные данные клиента из браузера для потенциально опасных значений. (Унаследовано от Control) |
| ViewState |
Получает словарь сведений о состоянии, позволяющий сохранять и восстанавливать состояние представления серверного элемента управления в нескольких запросах на одну и ту же страницу. (Унаследовано от Control) |
| ViewStateIgnoresCase |
Возвращает значение, указывающее, является ли StateBag объект нечувствительным к регистру. (Унаследовано от Control) |
| ViewStateMode |
Возвращает или задает режим состояния представления этого элемента управления. (Унаследовано от Control) |
| Visible |
Возвращает или задает значение, указывающее, отображается ли серверный элемент управления в виде пользовательского интерфейса на странице. (Унаследовано от Control) |
| Width |
Возвращает или задает ширину элемента управления веб-сервера. (Унаследовано от WebControl) |
Методы
| Имя | Описание |
|---|---|
| AddAttributesToRender(HtmlTextWriter) |
Добавляет атрибуты и стили HTML, которые должны быть отрисованы в указанные HtmlTextWriterTag. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| AddedControl(Control, Int32) |
Вызывается после добавления дочернего Control элемента управления в Controls коллекцию объекта. (Унаследовано от Control) |
| AddParsedSubObject(Object) |
Уведомляет серверный элемент управления о том, что элемент , XML или HTML, был проанализирован, и добавляет элемент в объект элемента управления ControlCollection сервера. (Унаследовано от Control) |
| ApplyStyle(Style) |
Копирует все небланковые элементы указанного стиля в веб-элемент управления, перезаписыв все существующие элементы стиля элемента управления. Этот метод в основном используется разработчиками элементов управления. (Унаследовано от WebControl) |
| ApplyStyleSheetSkin(Page) |
Применяет свойства стиля, определенные в таблице стилей страницы, к элементу управления. (Унаследовано от Control) |
| BeginRenderTracing(TextWriter, Object) |
Начинает трассировку данных отрисовки во время разработки. (Унаследовано от Control) |
| BuildProfileTree(String, Boolean) |
Собирает сведения о серверном элементе управления и передает его Trace свойству, которое будет отображаться при включении трассировки для страницы. (Унаследовано от Control) |
| ClearCachedClientID() |
Задает кэшированное ClientID значение |
| ClearChildControlState() |
Удаляет сведения о состоянии элемента управления для дочерних элементов управления сервера. (Унаследовано от Control) |
| ClearChildState() |
Удаляет сведения о состоянии представления и состояния элемента управления для всех дочерних элементов управления сервера. (Унаследовано от Control) |
| ClearChildViewState() |
Удаляет сведения о состоянии представления для всех дочерних элементов управления сервера. (Унаследовано от Control) |
| ClearEffectiveClientIDMode() |
ClientIDMode Задает свойство текущего экземпляра элемента управления и всех дочерних элементов управленияInherit. (Унаследовано от Control) |
| CopyBaseAttributes(WebControl) |
Копирует свойства, не инкапсулированные Style объектом из указанного элемента управления веб-сервера, в элемент управления веб-сервера, из который вызывается этот метод. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| CreateChildControls() |
Очищает текущую коллекцию дочерних элементов управления и перестраивает его путем вызова CreateControlHierarchy() метода. |
| CreateControlCollection() |
Создает новый ControlCollection объект для хранения дочерних элементов управления (как литерала, так и сервера) элемента управления сервером. (Унаследовано от Control) |
| CreateControlHierarchy() |
Проверяет структуру карты сайта, предоставляемую SiteMapProvider и создает коллекцию дочерних элементов управления на основе стилей и шаблонов, определенных для функциональных узлов. |
| CreateControlStyle() |
Создает объект стиля, который используется внутри WebControl класса для реализации всех свойств, связанных со стилем. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| DataBind() |
Привязывает источник данных к элементу управления и его дочерним SiteMapPath элементам управления. |
| DataBind(Boolean) |
Привязывает источник данных к вызываемой серверной системе управления и всем его дочерним элементам управления с возможностью вызвать DataBinding событие. (Унаследовано от Control) |
| DataBindChildren() |
Привязывает источник данных к дочерним элементам управления сервера. (Унаследовано от Control) |
| Dispose() |
Позволяет элементу управления сервера выполнять окончательную очистку перед освобождением из памяти. (Унаследовано от Control) |
| EndRenderTracing(TextWriter, Object) |
Завершает трассировку времени разработки данных отрисовки. (Унаследовано от Control) |
| EnsureChildControls() |
Определяет, содержит ли серверный элемент управления дочерние элементы управления. Если это не так, он создает дочерние элементы управления. (Унаследовано от Control) |
| EnsureID() |
Создает идентификатор для элементов управления, которым не назначен идентификатор. (Унаследовано от Control) |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| FindControl(String, Int32) |
Выполняет поиск текущего контейнера именования для элемента управления сервером с указанным |
| FindControl(String) |
Выполняет поиск текущего контейнера именования для элемента управления сервером с указанным |
| Focus() |
Задает фокус ввода элементу управления. (Унаследовано от Control) |
| GetDesignModeState() |
Возвращает данные во время разработки для элемента управления. (Унаследовано от Control) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetRouteUrl(Object) |
Возвращает URL-адрес, соответствующий набору параметров маршрута. (Унаследовано от Control) |
| GetRouteUrl(RouteValueDictionary) |
Возвращает URL-адрес, соответствующий набору параметров маршрута. (Унаследовано от Control) |
| GetRouteUrl(String, Object) |
Получает URL-адрес, соответствующий набору параметров маршрута и имени маршрута. (Унаследовано от Control) |
| GetRouteUrl(String, RouteValueDictionary) |
Получает URL-адрес, соответствующий набору параметров маршрута и имени маршрута. (Унаследовано от Control) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| GetUniqueIDRelativeTo(Control) |
Возвращает префиксированную часть UniqueID свойства указанного элемента управления. (Унаследовано от Control) |
| HasControls() |
Определяет, содержит ли серверный элемент управления какие-либо дочерние элементы управления. (Унаследовано от Control) |
| HasEvents() |
Возвращает значение, указывающее, регистрируются ли события для элемента управления или любых дочерних элементов управления. (Унаследовано от Control) |
| InitializeItem(SiteMapNodeItem) |
Заполняет SiteMapNodeItemэлемент управления веб-сервера, представляющий SiteMapNodeнабор дочерних элементов управления на основе функции узла и указанных шаблонов и стилей узла. |
| IsLiteralContent() |
Определяет, содержит ли серверный элемент управления только литеральное содержимое. (Унаследовано от Control) |
| LoadControlState(Object) |
Восстанавливает сведения о состоянии элемента управления из предыдущего запроса страницы, сохраненного методом SaveControlState() . (Унаследовано от Control) |
| LoadViewState(Object) |
Восстанавливает сведения о состоянии представления из предыдущего запроса, сохраненного SaveViewState() с помощью метода. |
| MapPathSecure(String) |
Извлекает физический путь, с которым сопоставляется виртуальный путь( абсолютный или относительный). (Унаследовано от Control) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| MergeStyle(Style) |
Копирует все небланковые элементы указанного стиля в веб-элемент управления, но не перезаписывает существующие элементы стиля элемента управления. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| OnBubbleEvent(Object, EventArgs) |
Определяет, передается ли событие для элемента управления сервером пользовательского интерфейса страницы. (Унаследовано от Control) |
| OnDataBinding(EventArgs) |
Переопределяет OnDataBinding(EventArgs) метод CompositeControl класса и вызывает DataBinding событие. |
| OnInit(EventArgs) |
Вызывает событие Init. (Унаследовано от Control) |
| OnItemCreated(SiteMapNodeItemEventArgs) |
ItemCreated Вызывает событие SiteMapPath элемента управления. |
| OnItemDataBound(SiteMapNodeItemEventArgs) |
ItemDataBound Вызывает событие SiteMapPath элемента управления. |
| OnLoad(EventArgs) |
Вызывает событие Load. (Унаследовано от Control) |
| OnPreRender(EventArgs) |
Вызывает событие PreRender. (Унаследовано от Control) |
| OnUnload(EventArgs) |
Вызывает событие Unload. (Унаследовано от Control) |
| OpenFile(String) |
Возвращает используемый Stream для чтения файла. (Унаследовано от Control) |
| RaiseBubbleEvent(Object, EventArgs) |
Назначает любые источники события и ее сведения родительскому элементу управления. (Унаследовано от Control) |
| RecreateChildControls() |
Повторно создает дочерние элементы управления, производные от CompositeControlэлемента управления. (Унаследовано от CompositeControl) |
| RemovedControl(Control) |
Вызывается после удаления дочернего Control элемента управления из Controls коллекции объекта. (Унаследовано от Control) |
| Render(HtmlTextWriter) |
Записывает содержимое CompositeControl в указанный HtmlTextWriter объект для отображения на клиенте. |
| RenderBeginTag(HtmlTextWriter) |
Отрисовывает HTML-тег открывающего элемента управления указанному средству записи. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| RenderChildren(HtmlTextWriter) |
Выводит содержимое дочерних элементов управления сервера в предоставленный HtmlTextWriter объект, который записывает содержимое для отрисовки на клиенте. (Унаследовано от Control) |
| RenderContents(HtmlTextWriter) |
Отрисовывает узлы в элементе SiteMapPath управления. |
| RenderControl(HtmlTextWriter, ControlAdapter) |
Выводит содержимое элемента управления сервером в предоставленный HtmlTextWriter объект с помощью предоставленного ControlAdapter объекта. (Унаследовано от Control) |
| RenderControl(HtmlTextWriter) |
Выводит содержимое сервера управления в предоставленный HtmlTextWriter объект и сохраняет сведения о трассировке элемента управления, если трассировка включена. (Унаследовано от Control) |
| RenderEndTag(HtmlTextWriter) |
Отрисовывает html-закрывающий тег элемента управления в указанный модуль записи. Этот метод используется главным образом разработчиками элементов управления. (Унаследовано от WebControl) |
| ResolveAdapter() |
Возвращает адаптер управления, отвечающий за отрисовку указанного элемента управления. (Унаследовано от Control) |
| ResolveClientUrl(String) |
Получает URL-адрес, который может использоваться браузером. (Унаследовано от Control) |
| ResolveUrl(String) |
Преобразует URL-адрес в url-адрес, который можно использовать на запрашиваемом клиенте. (Унаследовано от Control) |
| SaveControlState() |
Сохраняет все изменения состояния управления сервером, которые произошли с момента публикации страницы на сервер. (Унаследовано от Control) |
| SaveViewState() |
Сохраняет изменения в состоянии просмотра элемента SiteMapPath управления. |
| SetDesignModeState(IDictionary) |
Задает данные во время разработки для элемента управления. (Унаследовано от Control) |
| SetRenderMethodDelegate(RenderMethod) |
Назначает делегат обработчика событий для отрисовки элемента управления сервером и его содержимого в родительский элемент управления. (Унаследовано от Control) |
| SetTraceData(Object, Object, Object) |
Задает данные трассировки для трассировки данных отрисовки во время разработки, используя объект трассировки, ключ данных трассировки и значение данных трассировки. (Унаследовано от Control) |
| SetTraceData(Object, Object) |
Задает данные трассировки для трассировки данных отрисовки во время разработки, используя ключ данных трассировки и значение данных трассировки. (Унаследовано от Control) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
| TrackViewState() |
Отслеживает изменения SiteMapPath состояния представления элемента управления. |
События
| Имя | Описание |
|---|---|
| DataBinding |
Происходит, когда серверный элемент управления привязывается к источнику данных. (Унаследовано от Control) |
| Disposed |
Происходит при освобождении серверного элемента управления из памяти, который является последним этапом жизненного цикла управления сервера при запросе страницы ASP.NET. (Унаследовано от Control) |
| Init |
Происходит при инициализации серверного элемента управления, который является первым шагом в его жизненном цикле. (Унаследовано от Control) |
| ItemCreated |
Происходит при SiteMapNodeItem создании SiteMapPath и сопоставлении его соответствующего SiteMapNodeобъекта. Это событие вызывается методом OnItemCreated(SiteMapNodeItemEventArgs) . |
| ItemDataBound |
Происходит после SiteMapNodeItem привязки к базовым SiteMapNodeSiteMapPathданным. Это событие вызывается методом OnItemDataBound(SiteMapNodeItemEventArgs) . |
| Load |
Происходит при загрузке серверного элемента управления в Page объект. (Унаследовано от Control) |
| PreRender |
Происходит после Control загрузки объекта, но до отрисовки. (Унаследовано от Control) |
| Unload |
Происходит при выгрузке серверного элемента управления из памяти. (Унаследовано от Control) |
Явные реализации интерфейса
| Имя | Описание |
|---|---|
| IAttributeAccessor.GetAttribute(String) |
Возвращает атрибут веб-элемента управления с указанным именем. (Унаследовано от WebControl) |
| IAttributeAccessor.SetAttribute(String, String) |
Задает атрибут веб-элемента управления указанным именем и значением. (Унаследовано от WebControl) |
| ICompositeControlDesignerAccessor.RecreateChildControls() |
Позволяет конструктору воссоздать коллекцию дочерних элементов управления составного элемента управления в среде разработки. (Унаследовано от CompositeControl) |
| IControlBuilderAccessor.ControlBuilder |
Описание этого элемента см. в разделе ControlBuilder. (Унаследовано от Control) |
| IControlDesignerAccessor.GetDesignModeState() |
Описание этого элемента см. в разделе GetDesignModeState(). (Унаследовано от Control) |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) |
Описание этого элемента см. в разделе SetDesignModeState(IDictionary). (Унаследовано от Control) |
| IControlDesignerAccessor.SetOwnerControl(Control) |
Описание этого элемента см. в разделе SetOwnerControl(Control). (Унаследовано от Control) |
| IControlDesignerAccessor.UserData |
Описание этого элемента см. в разделе UserData. (Унаследовано от Control) |
| IDataBindingsAccessor.DataBindings |
Описание этого элемента см. в разделе DataBindings. (Унаследовано от Control) |
| IDataBindingsAccessor.HasDataBindings |
Описание этого элемента см. в разделе HasDataBindings. (Унаследовано от Control) |
| IExpressionsAccessor.Expressions |
Описание этого элемента см. в разделе Expressions. (Унаследовано от Control) |
| IExpressionsAccessor.HasExpressions |
Описание этого элемента см. в разделе HasExpressions. (Унаследовано от Control) |
| IParserAccessor.AddParsedSubObject(Object) |
Описание этого элемента см. в разделе AddParsedSubObject(Object). (Унаследовано от Control) |
Методы расширения
| Имя | Описание |
|---|---|
| EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
Включает поведение динамических данных для указанного элемента управления данными. |
| EnableDynamicData(INamingContainer, Type, Object) |
Включает поведение динамических данных для указанного элемента управления данными. |
| EnableDynamicData(INamingContainer, Type) |
Включает поведение динамических данных для указанного элемента управления данными. |
| FindDataSourceControl(Control) |
Возвращает источник данных, связанный с элементом управления данными для указанного элемента управления. |
| FindFieldTemplate(Control, String) |
Возвращает шаблон поля для указанного столбца в контейнере именования указанного элемента управления. |
| FindMetaTable(Control) |
Возвращает объект метатабли для содержащего элемента управления данными. |
| GetDefaultValues(INamingContainer) |
Возвращает коллекцию значений по умолчанию для указанного элемента управления данными. |
| GetMetaTable(INamingContainer) |
Возвращает метаданные таблицы для указанного элемента управления данными. |
| SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
Задает сопоставление метаданных таблицы и значений по умолчанию для указанного элемента управления данными. |
| SetMetaTable(INamingContainer, MetaTable, Object) |
Задает сопоставление метаданных таблицы и значений по умолчанию для указанного элемента управления данными. |
| SetMetaTable(INamingContainer, MetaTable) |
Задает метаданные таблицы для указанного элемента управления данными. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Определяет, доступны ли метаданные таблицы. |