On-line users

   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 and in on-site editing mode. If empty, the value of the Web part control ID property is used for this purpose.  
   

  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  
  Transformation name: Sets the transformation used to display the on-line users. You can use the default CMS.Root.OnLineUsers transformation, which displays user names separated by spaces.  
  Path: If you enter an alias path here, only users that are accessing pages found under the specified path will be displayed.  
  Select top N: Sets the maximum number of users that will be loaded and displayed in the list of on-line users.  
  Additional info text: Sets the text which will be displayed above the list of on-line users. You can use the following formatting macros that will be resolved into the appropriate number: {0} - number of all connected users {2} - number of connected registered users {1} - number of connected anonymous users  
  No users on-line text: Sets the text that will be displayed if no users are currently online.  
  Columns: Lists which columns should be loaded from the CMS_User or CMS_UserSettings tables along with user records. Column names need to be separated by commas ( , ). Specifying a list without unnecessary columns may significantly improve performance. These columns may be used in the code of the specified transformation to display data related to the given users.  
   

  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 contain a single item only. 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 containers defined in 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.  
   

  Performance  
  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.  
  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 contain a single item only. 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.  
   

  Output filter  
  Filter output HTML of web part: If checked, the output code of this web part is processed by the output filters  
  Resolve URLs: If checked, the filter removes the "~" character in relative URLs and replace it with the root URL of the website.  
  Fix attributes: If checked, the filter ensures that all HTML tag attributes are in valid XHTML format.  
  Fix Javascript: If checked, the filter ensures that the type and language attributes are included in all <script> tags.  
  Fix lower case: If checked, the filter ensures that all HTML tags and attributes are generated in lower case.  
  Fix self closing tags: If checked, the filter ensures that HTML tags without end tags are properly closed.  
  Fix tags: If checked, the filter replaces tags that are not XHTML valid with appropriate equivalents (<strong> instead of <b>, <em> instead of <i>).  
  Fix HTML5: If checked, the filter replaces attributes that are obsolete in HTML5 with CSS classes named in format <attribute name>_<attribute value>. The affected attributes are: cellpadding, cellspacing, width, height, border, align, valign  
  Convert TABLE tags to DIV tags: If enabled, the TABLE tags in the output are automatically converted to DIV tags with CSS class corresponding to the tag name (table, tr, td, etc.) Blocks of HTML code can be optionally marked with class="_divs" or class="_nodivs" to allow or disable conversion for that particular block of code.  
   

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