AppendSaveConfigName property

Use the AppendSaveConfigName property to determine if the SaveConfigName property value is appended to an entity ID.

When the configuration data (column widths or sort orders) for a control is saved to the database, the instance name for the saved configuration (specifically, this is the config_id field in the UI_Config table) is the entity ID by default. The AppendSaveConfigName and SaveConfigName properties allow this default to be changed.

• If AppendSaveConfigName is set to True and the SaveConfigName is not an empty string, the SaveConfigName is prepended to the entity ID to form the instance name for the saved configuration.

  For example, if SaveConfigName is ABC and the entity ID is 53, setting the AppendSaveConfigName to True causes the control’s configuration data to be stored with an instance name of ABC53.

  If AppendSaveConfigName is True, but SaveConfigName is an empty string, the AppendSaveConfigName property has no effect; the entity ID is used.

• If AppendSaveConfigName is False and the SaveConfigName is not an empty string, the SaveConfigName is used instead of the entity ID. In other words, the entity ID is not used at all in the instance name for the saved configuration data.

  For example, if SaveConfigName is set to XYZ and AppendSaveConfigName is False, the control’s configuration data is saved with an instance name of XYZ.

  Data Type	Read/Write	Default Value
  Boolean	R/W	True