Setup Properties

The following Setup Properties are available for use with the Tree Display Adapter. Click on a link to go directly to that section.

•    Add Column XML

•    Convert XML

•    Enforce Post Input

•    Load on Demand URL

•    Node Setup XML

•    Pass Through XML

•    Tree Setup XML

•    URL To XML

•    Use Generic Node XML

Add Column XML

Used to add a column to the data collected from the external XML sources. This is useful if you want to set a default value for a column if the initial column is null, like a currency field.

Go to http://msdn2.microsoft.com/en-us/library/system.data.datacolumn.expression(VS.71).aspx for more information.

Example:

<AddColumn>

<Column>

<ColumnName>ZeroOfGroup1</ColumnName>

<ColumnType>System.Int32</ColumnType>

<Expression>IsNull(1*[Group Value0], 0)</Expression>

</Column>

</AddColumn>

ColumnName (Required) - String

The name of the column you want to add.

ColumnType (Optional) - String

The type of column you want to add. See Convert XML for available options.

Expression (Optional) - String

The expression used to store data within the column.

Back to Top

 

Convert XML

Use this property convert fields collected from the external XML from a string to a different type.

Example:

<Convert>

<Column>

<ColumnName>Start Date</ColumnName>

<ColumnType>System.DateTime</ColumnType>

</Column>

<Column>…</Column>

</Convert>

ColumnName (required) – String

The name of the column you want to convert.

ColumnType (required) – String

The System Type you want to convert the column to.

Options:

•    System.Boolean

•    System.Byte

•    System.Char

•    System.DateTime

•    System.Decimal

•    System.Double

•    System.Int16

•    System.Int32

•    System.Int64

•    System.SByte

•    System.Single

•    System.String

•    System.TimeSpan

•    System.UInt16

•    System.UInt32

•    System.UInt64

TableName (Optional) – String

The name of the table which contains the column to convert. The TableName comes from the Table node used in the XML. For instance if your xml looks like “<Data><Title>Hello</Title></Data><Data><Title>World</Title></Data>” the name of your table is “Data”.

Back to Top

 

Enforce Post Input

When enabled, this property forces information to be passed into the page a post request, rather than a get request. This disables the ability to add ?Parameter=Value to the page.

Back to Top

 

Load on Demand URL

The URL to the provider which will provide Site Structure XML based upon a specific site selected in the tree.

•    Use “%NodeURL%” to replace the selected node's URL. Use “%NodeID%” to replace the selected node's ID

•    Use “%NodeText%” to replace the selected node's Text

•    Use “%NodeValue%” to replace the selected node's Value

The Load on Demand response should not include a parent item, but child items which will belong to the parent item expanded.

Example: <%SiteURL%>/SiteList%20Provider/LocalSite.aspx?StoreParentSite=false&SiteURL=%NodeURL%

Back to Top

 

Node Setup XML

When data is collected using the Load on Demand URL (above), these settings will be applied to the context collected and displayed within the tree. Each element value indicates the column from the data which contains the setting.

EnableContextMenu

A true/false indication that the item should be displayed with a context menu.

ToolTip

The text displayed when an item is hovered over.

HoveredImageUrl

The URL to the image displayed when an item is hovered over.

HoveredCssClass

The CSS Class style used when an item is hovered over.

ImageUrl

The URL for the image to be used for the item.

BackColor

The HEX background color of each node.

BorderColor

The HEX border color of each node.

BorderStyle

The border style used for each node.

BorderWidth

The border width of each node, measured in points.

FontBold

A true/false indication that the text should be bolded.

FontItalic

A true/false indication that the text should be Italic.

FontName

The name of the server font to be used for each node.

FontOverline

A true/false indication that a line should be displayed over the text.

FontSize

The size of the displayed text, measured in points.

FontStrikeout

A true/false indication that the text should be struck.

FontUnderline

A true/false indication that the text should be underlined.

DisabledCssClass

The CSS Class style to use if the item is disabled and cannot be expanded.

DisabledImageUrl

The URL to the image to use if the item is disabled and cannot be expanded.

Expanded

A true/false indication that the item should be expanded by default.

ExpandedImageUrl

The URL to the image to use if the item is expanded

ForeColor

The HEX font color of each node.

Selected

A true/false indication that the item is pre-selected.

SelectedCssClass

The CSS Class style name to use when an item is selected.

SelectedImageUrl

The URL of the image to use when an item shown as selected.

TabIndex

The tab index order of the context menu item.

Target

The target window, frame, or browser that will be used when an item is clicked.

Visible

A true/false indication that the item should be displayed.

Width

The width of each node, measured in points.

Example:

<GC>

<C>

<EnableContextMenu>IsList</EnableContextMenu>

<ExpandMode>TreeExpandMode</ExpandMode>

<ImageUrl>ImgUrl</ImageUrl>

<Expanded>IsParent</Expanded>

</C>

</GC>

Back to Top

 

Pass Through XML

When enabled, this property will pass page parameters onto the page specified in the URL To XML property. This supports the Common Use Variables stated at the beginning of this help topic. You must encode the < and > symbol when using the parameters (e.g., < &lt; and > &gt;).

Example:

                <PassThrough>

                                <Pass>

                                                <PTType>get</PTType>

                                                <PTRequest>SearchString</PTRequest>

                                                <PTName>SearchString</PTName>

                                                <PTDefault>[Me]</PTDefault>

                                </Pass>

</PassThrough>

PTDefault (Optional) – String

The default text that will be sent to the page from which data is being requested, if the parameter is not passed into the page.

PTName (Required) – String

The name of the parameter to be passed onto the page from which data is being requested.

PTRequest (Required) – String

The name of the parameter being received by the page.

PTType (Required) – String

Controls the type of pass through. Use "post" to store the parameters in the header of your request, or "get" to store them in the URL.

Options:

•    post

•    get

Back to Top

 

Tree Setup XML

Controls the data that will be displayed and the design of each item displayed in the tree. This does not affect the Node Setup XML.

DataTextField

The name of the column from the data that controls the Text to use for each node.

DataFieldID

The name of the column from the data that controls the ID of each node.

DataValueField

The name of the column from the data that controls the Value of each node.

DataParentField

The name of the column from the data that controls the node’s parent ID.

DataNavigateURLField

The name of the column from the data that controls the URL used when a user clicks on a node.

OnClientContextMenuItemClicked

The JavaScript function name to be called when a context menu item is clicked.

OnClientContextMenuItemClicking

The JavaScript function name to be called when a context menu item is being clicked.

OnClientContextMenuShowing

The JavaScript function name to be called when a context menu item is showing.

OnClientContextMenuShown

The JavaScript function name to be called when a context menu item is shown.

FontBold

A true/false indication that the text should be bolded.

FontItalic

A true/false indication that the text should be italicized.

FontName

The name of the server font to be used for each node.

FontOverline

A true/false indication that a line should be displayed over the text.

FontSize

The size of the displayed text, measured in points.

FontStrikeout

A true/false indication that the text should be struck.

FontUnderline

A true/false indication that the text should be underlined.

BackColor

The HEX background color of each node.

ForeColor

The HEX font color of each node.

BorderColor

The HEX border color of each node.

BorderStyle

The border style used for each node.

BorderWidth

The border width of each node, measured in points.

Height

The height of each node, measured in points.

LoadingMessage

The message to show when a Load on Demand item is clicked.

LoadingStatusPosition

The position of the Loading Text to display.

•    BeforeNodeText - If the node text is "Some Text", the text is changed to "(loading ...) Some Text" when child nodes are being loaded (assuming the LoadingMessage property has been set to "(loading...)"

•    AfterNodeText - If the node text is "Some Text", the text is changed to "Some Text (loading ...)" when child nodes are being loaded (assuming the LoadingMessage property has been set to "(loading...)"

•    BelowNodeText               - The text is not changed and "(loading ...)" is displayed when child nodes are being loaded (assuming the LoadingMessage property has been set to "(loading...)"

•    None - No loading text is displayed at all

ShowLineImages

A true/false indication that line images from node to node are displayed.

SingleExpandPath

A true/false indication that only the current first level of nodes may be expanded.

Skin

The pre-defined style used for each node item.

•    Black

•    Default

•    Forest

•    Hay

•    Office2007

•    Outlook

•    Simple

•    Sunset

•    Telerik

•    Vista

•    Web20

•    WebBlue

ToolTip

The text displayed when a node is hovered over.

Visible

A true/false indication if the item should be displayed.

Width

The width of each node, measured in points.

Example:

<CG>

<C>

<OnClientContextMenuItemClicking>clientContextMenuItemClicking</OnClientContextMenuItemClicking>

<DataTextField>Title</DataTextField>

<DataFieldID>ID</DataFieldID>

<DataValueField>ParentID</DataValueField>

<DataNavigateURLField>Url</DataNavigateURLField>

<DataParentField>ParentID</DataParentField>

<Skin>Vista</Skin>

</C>

</CG>

Back to Top

 

URL To XML

The URL to the data source that the grid will be data bound to. This property also supports the Common Use Variables stated at the beginning of this help topic.

Default:  empty

Example:             http://domain.com/GridDataSources/Tasks
                                <%SiteURL%>/GridDataSources/Tasks

Back to Top

 

Use Generic Node XML

If the data being collected is already in an XML format, use this option and none of the other tree settings will be applied. Data being collected would look something like this:

<Tree>

                <Node Text="North America" Expanded="True" Value="1">

                <Node Text=”Maryland”>

                 <Node Text=”Baltimore”>

                 </Node>

                </Node>

                </Node>

</Tree>

Back to Top