|
|
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
|
|
|
|
|
Selected path:
|
Can be used to set a static path that will be displayed in the breadcrumbs. In this case, the items in the breadcrumbs are links to all documents on the given path. If you wish to use the breadcrumbs to display the current user's position on the website, leave this property empty.
|
|
|
|
Default path:
|
Sets the default path that should be displayed in the breadcrumbs if no path is provided from the current page context.
|
|
|
|
Starting path:
|
Selects the document from which the path in the breadcrumbs will be displayed. Enter / (root document) to have the breadcrumbs display the full website path. For example, if you set this value to /News and go to /News/Events/2010, the breadcrumbs will display only Events -> 2010.
|
|
|
|
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.
|
|
| | | |
|
|
Content filter
|
|
|
|
|
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.
|
|
|
|
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.
|
|
| | | |
|
|
Design
|
|
|
|
|
Breadcrumb separator:
|
Sets the HTML code of the separator placed between items in the breadcrumbs navigation. All options are supported, from a single character (>) to a custom image (<img src="/images/myseparator.gif">).
|
|
|
|
Breadcrumb separator RTL:
|
Works the same way as the Breadrumb separator property, but is used if the page is displayed in a right-to-left culture.
|
|
|
|
Show current item:
|
Indicates if the currently selected document should be displayed in the breadcrumbs navigation.
|
|
|
|
Show current item as a link:
|
Indicates whether the current breadcrumbs item should be generated as a link.
|
|
|
|
Target frame:
|
Specifies the name of the target frame in which the navigation links will be opened. For example: _blank
|
|
|
|
Apply menu design:
|
Indicates if document settings for menu design should be applied to the navigation items displayed by the web part. These settings can be configured for individual documents in CMS Desk -> Content -> Edit -> Properties -> Menu.
|
|
|
|
Render link title:
|
If enabled, the web part will render the title attribute of items in the breadcrumbs as a tooltip. This can improve the accessibility of your website.
|
|
|
|
Use RTL behaviour:
|
If selected, the breadcrumbs will use a right-to-left layout if the document is displayed in a RTL culture.
|
|
|
|
Ignore Show in navigation:
|
If checked, even documents that have the Show in navigation property disabled will be displayed in the breadcrumbs. This setting can be configured for individual documents in CMS Desk -> Content -> Edit -> Properties -> Menu.
|
|
|
|
Encode name:
|
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.
|
|
| | | |
|
|
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?breadcrumbs_properties.htm
