TreeNodeBinding.Target Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the target window or frame in which to display the Web page content that is associated with a node to which the TreeNodeBinding object is applied.

public:
 property System::String ^ Target { System::String ^ get(); void set(System::String ^ value); };

public string Target { get; set; }

member this.Target : string with get, set

Public Property Target As String

Property Value

String

The target window or frame in which to display the linked Web page content. Values must begin with a letter in the range of A through Z (case insensitive), except for certain special values that begin with an underscore, as shown in the following table.

Target value	Description
`_blank`	Renders the content in a new window without frames.
`_parent`	Renders the content in the immediate frameset parent.
`_search`	Renders the content in the search pane.
`_self`	Renders the content in the frame with focus.
`_top`	Renders the content in the full window without frames.

Note: Check your browser documentation to determine if the _search value is supported. For example, Microsoft Internet Explorer version 5.0 and later supports the _search target value.

The default is an empty string (""), which refreshes the window or frame with focus.

Examples

This section contains two code examples. The first code example demonstrates how to use the Target property to specify that the Web page that is associated with the root node should be displayed in a new window. The second code example provides sample XML data for the first code example.

The following example demonstrates how to use the Target property to specify that the Web page that is associated with the root node should be displayed in a new window. For this example to work correctly, you must copy the sample XML data, provided after this code example, to a file named Book.xml.


<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeNodeBinding Target Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>TreeNodeBinding Target Example</h3>
    
      <!-- Clicking the root node will navigate  -->
      <!-- the user to another page. Because the -->
      <!-- Target property is set to "_blank",   -->
      <!-- the linked page is displayed in a new -->
      <!-- window.                               -->
      <asp:TreeView id="BookTreeView" 
         DataSourceID="BookXmlDataSource"
         runat="server">
          
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" 
            Depth="0" 
            TextField="Title"
            NavigateUrl="~\Page1.aspx"
            Target="_blank"/>
          <asp:TreeNodeBinding DataMember="Chapter" 
            Depth="1" 
            TextField="Heading"/>
          <asp:TreeNodeBinding DataMember="Appendix" 
            Depth="1" 
            TextField="Heading"/>
        </DataBindings>
         
      </asp:TreeView>
      
      <asp:XmlDataSource id="BookXmlDataSource"  
         DataFile="Book.xml"
         runat="server">
      </asp:XmlDataSource>
    
    </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">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>TreeNodeBinding Target Example</title>
</head>
<body>
    <form id="form1" runat="server">
    
      <h3>TreeNodeBinding Target Example</h3>
    
      <!-- Clicking the root node will navigate  -->
      <!-- the user to another page. Because the -->
      <!-- Target property is set to "_blank",   -->
      <!-- the linked page is displayed in a new -->
      <!-- window.                               -->
      <asp:TreeView id="BookTreeView" 
         DataSourceID="BookXmlDataSource"
         runat="server">
          
        <DataBindings>
          <asp:TreeNodeBinding DataMember="Book" 
            Depth="0" 
            TextField="Title"
            NavigateUrl="~\Page1.aspx"
            Target="_blank"/>
          <asp:TreeNodeBinding DataMember="Chapter" 
            Depth="1" 
            TextField="Heading"/>
          <asp:TreeNodeBinding DataMember="Appendix" 
            Depth="1" 
            TextField="Heading"/>
        </DataBindings>
         
      </asp:TreeView>
      
      <asp:XmlDataSource id="BookXmlDataSource"  
         DataFile="Book.xml"
         runat="server">
      </asp:XmlDataSource>
    
    </form>
  </body>
</html>

The following code example provides sample XML data for the preceding code example.

<Book Title="Book Title">  
    <Chapter Heading="Chapter 1">  
        <Section Heading="Section 1">  
        </Section>  
        <Section Heading="Section 2">  
        </Section>  
    </Chapter>  
    <Chapter Heading="Chapter 2">  
        <Section Heading="Section 1">  
        </Section>  
    </Chapter>  
    <Appendix Heading="Appendix A">  
    </Appendix>  
</Book>

Remarks

When the TreeView control is bound to a data source, use the Target property to specify the value to bind to the Target property of a TreeNode object. This binding relationship affects all TreeNode objects to which the TreeNodeBinding object is applied. The Target property is used to specify the window or frame in which to display the Web content that is linked to a node when that node is clicked.

Note

Setting the Target property overrides the Target property of the TreeView control for the nodes to which the TreeNodeBinding object is applied. You can selectively override the Target property by setting the Target property of each node directly.

Note

The Target property renders as a target attribute. The target attribute on anchor elements is not allowed in the XHTML 1.1 document type definition. Do not set the Target property, if the rendered output for the TreeNodeBinding control must be XHTML 1.1 compliant. For more information, see XHTML Standards in Visual Studio and ASP.NET.

When creating accessible Web pages, you should avoid using the Target property to target another window. For more information, see ASP.NET Accessibility.

The value of this property is stored in view state.

Applies to

Share via