Tree view

   Previous topic Next topic Print this topic Mail us feedback on this topic!

  Default  
  Web part control ID: Serves as an identifier for the web part. This ID must be unique within the context of each page template. The value of this property may only contain alphanumeric characters and the underscore character ( _ ).  
  Web part title: Title of the web part displayed on the Design tab of CMS Desk. If empty, the value of the Web part control ID property is used for this purpose.  
  Disable view state: Indicates if view state should be disabled for this web part.  
  Disable macros: If checked, macros contained in the values of the web part's properties will no longer be resolved.  
   

  Visibility  
  Visible: Indicates if the web part should be displayed.  
  Hide on subpages: Indicates if the web part should be hidden on sub-pages. If checked, the web part will not be displayed on documents that inherit the web part from a parent document.  
  Show for document types: Contains a list of document types on which the web part should be displayed. If the currently selected document uses the page template containing this web part, but its type is not specified by this property, the web part will be hidden. The document types in the list must be specified by their code names and separated by semicolons (;). If empty, the web part will be displayed on all document types.  
  Display to roles: Contains a list of roles to which the web part should be displayed. This may be used to implement documents with specific functionality for different types of users. The roles in the list must be specified by their code names and separated by semicolons (;). If empty, the web part will be displayed to all users.  
   

  Content  
  Path: Specifies the path of the documents that should be displayed. If empty, the path will be set to all documents of the given website (/%).  
   

  Content filter  
  Document types: Determines which document types should be displayed, specified by a list of code names separated by semicolons (;). By default, only CMS.MenuItem documents (pages) are displayed in navigation.  
  Combine with default culture: Indicates if the default language version of a document should be used as a replacement if a given document is not translated to the currently selected language. If the Use site settings option is selected, the value is taken from Site Manager -> Settings -> Content -> Combine with default culture.  
  Culture code: Sets which culture version of the specified documents should be used.  
  Maximum nesting level: Specifies the maximum number of content tree sub-levels from which content should be loaded. This number is relative, i.e. counted from the start of the path specified for the content of the web part. Entering -1 causes all sub-levels to be included.  
  ORDER BY expression: Sets the value of the ORDER BY clause in the SELECT statement used to retrieve the content. Please be aware that it is necessary for the root of the displayed tree (or sub-tree) to be first in the resulting order, otherwise all documents may not be displayed correctly. This can be ensured by having the value of this property start with the NodeLevel column, such as for example: NodeLevel, NodeOrder  
  Select only published: Indicates if only published documents should be loaded.  
  Site name: Sets the website (specified by its code name) from which the content should be loaded. If left empty, the current site is used.  
  WHERE condition: Sets the value of the WHERE clause in the SELECT statement used to retrieve the content.  
  Columns: Lists database columns that should be loaded in addition to the set used by default; separated by commas (,). Entering an asterisk (*) causes all columns to be loaded. It is recommended to load only those columns that are necessary.  
  Filter name: Sets the name of the Filter web part that should be connected.  
   

  Node settings  
  Root text: Sets the text caption of the root node in the tree. This text is displayed instead of the document name of the item in the root of the tree.  
  Root image url: Contains the path to the image that is displayed next to the root node of the tree. For example: ~/App_Themes/Site/Images/root.gif  
  Node image url: Contains the path to the image that is displayed next to regular nodes in the tree. For example: ~/App_Themes/Site/Images/treeitem.gif  
   

  Behavior  
  Fix broken lines: Indicates whether the web part should try to fix broken lines in the tree.  
  Dynamic behavior: If enabled, sub-items are loaded dynamically when their parent node is expanded. This is recommended if there is a large amount of nodes in the tree, or if the content depends on other dynamic parameters.  
  Expand current path: Indicates if the path of the currently selected document should be expanded in the tree by default.  
  OnClick action: The entered JavaScript command will be executed when a user clicks on an item in the tree. If empty, the items in the tree will serve as links to the corresponding documents.  
  Expand all nodes on startup: If enabled, all nodes in the tree will be expanded by default when the page is loaded.  
  Expand sub-tree: Indicates whether the node of the currently selected document should be expanded by default (if it has child nodes).  
  Inactive root node: Indicates if the root node of the tree should be disabled (performs no action when clicked).  
  Inactive node image: Indicates if the images displayed next to nodes should also perform the specified action for the given item when clicked.  
  Inactivate selected item: If enabled, the node of the currently selected document will not perform any action when clicked.  
  Inactivate all items in path: If enabled, all nodes on the path of the currently selected document will not perform any action when clicked.  
  Hide root node: If enabled, the root of the tree will not be displayed.  
  Use doc-type images: If enabled, the images used for items in the tree will be loaded according to the document type of the given item.  
  Highlight selected item: Indicates if the currently selected node should be highlighted.  
  Ignore document menu action: Indicates if the menu action settings of individual documents should be ignored for items in the tree. This may be necessary if you wish to use the JavaScript command specified in the OnClick action property. Document menu action settings can be configured in CMS Desk -> Content -> Edit -> Properties -> Menu.  
  Target: Specifies the name of the target frame in which the navigation links will be opened. For example: _blank  
  Encode menu caption: Indicates whether HTML encoding should be applied to the navigation items. Useful only in special cases where the names of the displayed documents contain HTML code.  
   

  Design  
  Item style: Directly sets the style applied to items in the tree.  
  Item class: Specifies the name of the CSS class from the used stylesheet that will be applied to items in the tree.  
  Selected item style: Directly sets the style applied to the selected (highlighted) item in the tree.  
  Selected item class: Specifies the name of the CSS class from the used stylesheet that will be applied to the selected (highlighted) item in the tree.  
  Collapse image URL: Contains the path to the image that is displayed next to expanded (open) nodes in the tree and closes them when clicked. For example: ~/App_Themes/Site/Images/closeNode.gif  
  Expand image URL: Contains the path to the image that is displayed next to collapsed (closed) nodes in the tree and opens them when clicked. For example: ~/App_Themes/Site/Images/openNode.gif  
  Word wrap: Indicates if long menu item captions should be broken into multiple lines (word wrapped).  
  Inactive item class: Specifies the name of the CSS class from the used stylesheet that will be applied to inactive items in the tree.  
  Inactive item style: Directly sets the style applied to inactive items in the tree.  
  SkinID: Sets the SkinID of the skin that should be applied to the web part. The skin must be defined in the Default.skin file located in the App_Themes directory under the folder of the stylesheet used by the page.  
  Show lines: Indicates whether lines connecting child nodes to parent nodes should be displayed in the tree.  
  Collapse image ToolTip: Specifies the value of the ALT attribute for the images used to collapse (close) nodes in the tree.  
  Expand image ToolTip: Specifies the value of the ALT attribute for the images used to expand (open) nodes in the tree.  
  Line images folder: Sets the path to the folder that contains the line images used to connect child parent nodes to child nodes. If empty, the default images are used.  
  RTL Line images folder: Sets the path to the folder that contains the line images used to connect child parent nodes to child nodes when the document is displayed in a right-to-left culture. If empty, the default images are used.  
   

  No data behavior  
  Hide if no record found: Indicates if the web part should be hidden when no items to be displayed are retrieved.  
  No record found text: Text that should be displayed if no records are found. This text will not be visible if the Hide if no record found property of the web part is enabled.  
   

  System settings  
  Check permissions: Indicates if the permissions of the current user should be checked for the content of the web part. If enabled, only documents for which the user has the "read" permission will be loaded.  
  Cache item name: Sets the name of the cache key used for the content of the web part. If not specified, this name is generated automatically based on the site, document path, Web part control ID and current user. A cache key can be shared between multiple web parts with the same content on different pages in order to avoid keeping redundant data in the memory.  
  Cache minutes: Sets the number of minutes for which the content of the web part should remain cached before its latest version is reloaded from the database. If left empty, the value entered into the Site Manager -> Settings -> System -> Performance -> Cache content (minutes) setting will be used instead. If set to 0, caching will be disabled for the web part.  
  Cache dependencies: Contains a list of cache keys on which the partial cache of the web part depends. When the specified cache items change, the partial cache of the web part is deleted. Each line may only contain a single item. If the Use default cache dependencies box is checked, the default dependencies will be used, which include all possible object changes that could affect the specific web part.  
   

  Web part container  
  Web part container: Specifies the name of the container (box) to be displayed around the web part. Only the containers defined at Site Manager -> Development -> Web part containers can be selected. The selected container can be edited directly by using the Edit button.  
  Container title: Sets a title for the container. This title is displayed only if the {%ContainerTitle%} macro is used in the code of the container.  
  Container CSS class: CSS class used for the container. Applied only if the {%ContainerCSSClass%} macro is used as the value of the Class attribute in the code of the container.  
  Container custom content: Custom content to be used in the container. Applied only if the {%ContainerCustomContent%} macro is used in the code of the container.  
  Hide container on subpages: Indicates if the web part container should be hidden on sub-pages.  
   

  HTML Envelope  
  Content before: HTML content placed before the web part. Can be used to display a header or add some encapsulating code, such as <div> or <table> elements to achieve the required layout.  
  Content after: HTML content placed after the web part. Can be used to display a footer or close the tags contained in the ContentBefore value, such as </div> or </table> elements.  
   

  AJAX  
  Use update panel: Indicates if an AJAX UpdatePanel container should be used for this web part.  
   

  Time zones  
  Time zone: Specifies the type of time zone used for the content of the web part.  
  Custom time zone: May be used to assign a custom time zone specifically for the content of this web part. If selected, the time zone will be used regardless of current user or website time zone settings.  
   

  Partial caching  
  Partial cache minutes: Sets the number of minutes for which the output HTML code of the web part should remain cached. This process is similar to full-page caching, but only for the code of the web part specifically. If left empty or set to 0, partial caching will be not be used for the web part.  
  Partial cache dependencies: Contains a list of cache keys on which the partial cache of the web part depends. When the specified cache items change, the partial cache of the web part is deleted. Each line may only contain a single item. If the Use default cache dependencies box is checked, the default dependencies will be used, which include all possible object changes that could affect the specific web part.  
   

Help URL: http://devnet.kentico.com/docs/webparts/index.html?cmstreeview_properties.htm