Universal viewer with custom query

   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  
  Query name: Sets the name of the predefined SQL query that should be used to retrieve the data. Queries are specified in format <class name>.<query name>.  
   

  Content filter  
  ORDER BY expression: Sets the value of the ORDER BY clause in the query used to retrieve data. For this property to be applied, the used query must have the ##ORDERBY## macro expression as the value of its ORDER BY clause.  
  Select top N: Sets the maximum amount of items to be retrieved by the specified query. For this property to be applied, the used query must contain the ##TOPN## macro expression directly after its SELECT statement.  
  WHERE condition: Sets the value of the WHERE clause in the query used to retrieve data. For this property to be applied, the used query must have the ##WHERE## macro expression as the value of its WHERE clause.  
  Columns: Lists the columns (separated by commas) that should be loaded by the specified query. For this property to be applied, the used query must contain the ##COLUMNS## macro expression after its SELECT statement.  
  Filter name: Sets the name of the Filter web part that should be connected.  
   

  Hierarchical transformation  
  Hierarchical transformation: Sets the transformation to be used for the displayed documents in list view mode. This property can be used to set both standard and hierarchical transformations. Transformations are specified in format <class name>.<transformation name>.  
   

  Transformations  
  Transformation: Sets the transformation used for the displayed content in list view mode. Transformations are specified in format <class name>.<transformation name>.  
  Alternating transformation: Sets the transformation used to display even items in list view mode. Transformations are specified in format <class name>.<transformation name>.  
  Separator transformation: Sets the transformation used to separate the displayed items. Transformations are specified in format <class name>.<transformation name>.  
  Header transformation: Sets the transformation used at the beginning of every hierarchical level. Transformations are specified in format <class name>.<transformation name>.  
  Footer transformation: Sets the transformation used at the end of every hierarchical level. Transformations are specified in format <class name>.<transformation name>.  
  First item transformation: Sets the transformation applied to the first item displayed on every hierarchical level. Transformations are specified in format <class name>.<transformation name>.  
  Last item transformation: Sets the transformation applied to the last item displayed on every hierarchical level. Transformations are specified in format <class name>.<transformation name>.  
  Single item transformation: Sets the transformation applied when only a single item is displayed on a hierarchical level. Transformations are specified in format <class name>.<transformation name>.  
   

  Hierarchical settings  
  ID column: Sets the name of the column which serves as a unique identifier for objects. It is used in a parent-child relationship with the column specified in the 'ParentID column' property. It is recommended to use the NodeID column when displaying documents.  
  ParentID Column: Sets the name of the column that contains the unique identifier of an object's parent. It is used in a parent-child relationship with the column specified in the 'ID column' property. It is recommended to use the NodeParentID column when displaying documents.  
  Level column: Sets the name of the column used to determine an object's level in the hierarchy. It is recommended to use the NodeLevel column when displaying documents.  
  Selected item column: Sets the name of the column which should be used to identify the currently selected item. It is recommended to use the DocumentID column when displaying documents.  
  Selected item value: Can be used to enter a value of the column specified in the 'Selected item value' property to designate the currently selected item. The {%currentpageinfo.documentid%} macro can be entered to dynamically give the value of the current document.  
   

  Extended settings  
  Item separator: Contains the code of a separator to be placed between displayed items, e.g. <hr />.  
  Nested controls ID: Must contain the IDs of any nested controls, separated by semicolons (;). For example: myRepeaterID;myDatalistID;myRepeaterID2. This property replaces the previously used NestedRepeaterID and NestedDataListID properties. If you are still using these properties, no changes to functionality will occur, but it is advisable to rewrite your code to use the new property instead. If you need to dynamically set the properties of a nested control, you have to set its DelayedLoading property to 'True'. Please note that this setting can cause problems with ViewState.  
  Hide header & footer for single item: If checked, the header and footer transformations will not be applied if only a single item is displayed on a given hierarchical level.  
  Load hierarchical data: Indicates whether documents should be loaded with regard to their hierarchical position in the content tree. Hierarchical data has a parent-child relationship (NodeID/NodeParentID). Hierarchical transformations can be used for this type of data. Please be aware that hierarchical data cannot be displayed if paging is enabled.  
  Use default hierarchical order: Indicates whether the default hierarchical order should be used when displaying documents. This order is applied only if the LoadHierarchicalData property is enabled. The default order value is "NodeLevel, NodeOrder". The value of the ORDER BY expression property is added to the end of the order by clause.  
  Hierarchical display mode: Allows the hierarchical display mode to be selected. Inner: generates sub-levels inside the parent item (tree structure). Separate: generates sub-levels outside of the items on parent levels (flat structure).  
   

  Paging  
  Enable paging: Indicates if the displayed data should be paged.  
  Paging mode: Determines which method is used to pass information about the currently selected page - it can be passed either as a parameter in the URL (Query string) or through postback (Postback).  
  Pager position: Determines if the pager is displayed above or below the content displayed by the web part.  
  Page size: Determines the maximum number of records displayed per page.  
  Query string key: Sets the name of the URL parameter used to pass information about the current page number (used if the Paging mode property is set to Query string).  
  Group size: Sets the maximum amount of page number links that will be displayed together. Any additional links that do not fit can be accessed in the next or previous group.  
  Display first & last automatically: If enabled, the "go to first page" and "go to last page" buttons of the pager will be displayed only when there is no other way to access the first or last page through the pager.  
  Display previous & next automatically: If enabled, the "go to previous page" and "go to next page" buttons of the pager will be displayed only when there is no other way of accessing the previous or next page through the pager.  
  Hide pager for single page: Indicates whether the pager should be hidden if the displayed items fit onto a single page.  
   

  Pager design  
  Pages: Sets the transformation used for page links. Use <%# Eval("Page") %> to get the appropriate page number dynamically, <%# Eval("PageURL") %> to get the page URL or <%# Eval("PageLink") %> to get a link to the appropriate page.  
  CurrentPage: Sets the transformation used for the currently selected page. Use <%# Eval("Page") %> to get the current page number, <%# Eval("PageURL") %> to get the page URL or <%# Eval("PageLink") %> to get a link to the current page.  
  Page separator: Sets the transformation used as a separator between page links.  
  First page: Sets the transformation used for the link to the first page. Use <%# Eval("FirstURL") %> to get the URL of the first page.  
  Last page: Sets the transformation used for the link to the last page. Use <%# Eval("LastURL") %> to get the URL of the last page.  
  Previous page: Sets the transformation used for the link to the previous page. Use <%# Eval("PreviousURL") %> to get the URL of the previous page.  
  Next page: Sets the transformation used for the link to the next page. Use <%# Eval("NextURL") %> to get the URL of the next page.  
  Previous group: Sets the transformation used for the link to the previous group of page links. Use <%# Eval("PreviousGroupURL") %> to get the URL of the previous group.  
  Next group: Sets the transformation used for the link to the next group of page links. Use <%# Eval("NextGroupURL") %> to get the URL of the next group.  
  Direct page: Sets the transformation that implements direct page changing. Use a text box or drop-down list control with an ID set to "directPageControl" to register the page change event.  
  Pager layout: Sets the transformation that determines the overall design of the pager.  
   

  System settings  
  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.  
   

  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.  
   

  Editing buttons  
  Show New button: Indicates if the button for adding new documents should be displayed when viewing the page in edit mode. When the button is used, a document of the first type entered into the Document types property is created at the beginning of the path specified for the web part's content.  
  New button text: Sets the description text for the New document button.  
  Show Edit and Delete buttons: Indicates if edit and delete buttons should automatically be shown for each displayed item when viewing the page in edit mode.  
   

  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.  
  Web part 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?QueryUniView_properties.htm