Kentico CMS 7.0 Context Help

Properties tab

Properties tab

Previous topic Next topic Mail us feedback on this topic!  

Properties tab

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

On this tab you can manage the properties of the web part and sort them into categories.

 

Move up (Up) - moves the property up, which changes its position in the configuration dialog of the web part.

Move down (Down) - moves the property down.

New category (NewCategory) - creates a new category for properties. Properties belonging to a category are grouped together and displayed under a header. Each category will contain the properties defined below it.

New attribute (AddWebPart) - adds a new property.

Delete item (Delete) - deletes the currently selected property or category.

 

In the right hand part of the tab, you can define individual properties:

 

Please note: Not all settings may be available depending on the selected Attribute type.

 

Database

Column name

Sets a name that serves as an identifier for the property.

Attribute type

Type of value that the property should have.

Attribute size

Sets the maximum amount of characters that can be entered into the given property. Only available if the Attribute type is set to Text.

Allow empty value

If enabled, the property allows empty values.

 

If disabled, it users cannot save the configuration dialog of the web part unless there is a value entered in the given property. In this case, the property is required and an asterisk (*) is displayed next to it.

Default value

Predefined value for the given property, which is loaded by default when a new web part is created.

Translate field

Indicates if the content of the property should be included when using translation services for pages containing the web part.

 

Only available if the selected Attribute type is Text, Long text or File.

Display attribute in the editing form

If checked, the given property will be available in the web part configuration dialog.

Field appearance

Field caption

Name of the property which will be displayed in the web part configuration dialog.

Form control

Selects the form control that should be used for interaction with the given property in the web part configuration dialog.

 

If the form control that you need is not available in the drop-down list, you should be able to assign it through the dialog opened via the (more items ...) option.

Field description

Tooltip and documentation that will be displayed for this property.

Editing control settings

The settings in this section are used to perform additional configuration of the selected Form control, which affects the behavior or appearance of the property's field. The available options depend on the parameters defined for the given form control. Please see the tooltips of individual settings for more information.

 

This section also has two available modes. You can switch between Advanced and Simplified mode using the link on the side of the section. In simplified mode, only a limited set of parameters is offered (typically the most important ones).

Validation

Regular expression

This regular expression will be used by the validator of the property. Only available if the selected Attribute type is Text or Long text.

Min/Max length

Sets the minimum/maximum length for entered values. Only available if the selected Attribute type is Text or Long text.

Min/Max value

Sets the minimum/maximum value that can be entered. Only available if the selected Attribute type is numerical.

From/To

Can be used to specify a time interval into which the entered value must belong. Only available if the selected Attribute type is Date and time.

Error message

Error message displayed if a user attempts to enter an invalid value into the property.

CSS styles

Caption style

Here you can add CSS styles for the caption of the given property.

Input style

Here you can add CSS styles for the input of the property.

Control CSS class

Sets the name of the CSS class use to style the property.

Field advanced settings

Visible condition

May be used to enter a macro condition that must be fulfilled in order for the specific property to be visible in the web part's configuration dialog.

 

You can write any condition according to your specific requirements. For details about available macro options and syntax, please refer to the Development -> Macro expressions chapter of the Developer's Guide.

 

If you wish to create a condition that depends on the state of the other properties, you can access them in the macro expression using the corresponding Column name. The data of the properties may then be retrieved through the following parameters:

 

Value - returns the current value of the property. For example, ClassNames.Value is resolved into the value entered into the ClassNames property.

Visible - returns a true value if the given property is currently visible in the configuration dialog.

Enabled - true if the property is currently enabled, i.e. its value can be edited.

Info.<field setting> - may be used to access various settings configured for the property, for example: ClassNames.Info.DefaultValue

Enabled condition

Allows you to enter a macro condition that determines when the property should be enabled. If this condition is resolved as false, the property will be visible, but it will not be possible to edit its value.

 

You can use the same macro options as described above for the Visible condition setting.

Has depending fields

If enabled, the web part's configuration dialog will be refreshed via autopostback whenever the value of the given property is changed. This means that other properties can be dynamically updated according to the current value of the property.

 

Please note that the actual logic of the dependencies needs to be implemented in the code of the used form controls.

Depends on another field

This option must be enabled if you wish to have the behavior of the property dynamically changed according to the value of some other property.

 

The following options are available when creating or editing categories:

 

Category

Category name

Sets the name of the category that is displayed in the web part's configuration dialog.

Collapsible

If enabled, users will be able to collapse and expand the content of the category.

Collapsed by default

If enabled, the category will initially be collapsed when the configuration dialog is loaded.

Visible

Indicates if the category and all of the properties under it should be visible.

Visible condition

May be used to enter a macro condition that must be fulfilled in order for the category to be visible. You can use the same macro options as described above for the Visible condition setting of properties.

 

Any changes made to the settings of a property or category must be confirmed by clicking the Save Save button at the top.

 

Additional resources:

 

Developer's Guide -> Development -> Web parts -> Overview

Developer's Guide -> Development -> Web parts -> Developing web parts

Developer's Guide -> Development -> Form controls