ImportExportSettings Class

Class representing export/import settings in the type information of objects.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<ImportExportSettings>
    CMS.Base.AbstractDataContainer<ImportExportSettings>
      CMS.DataEngine.ImportExportSettings

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0

Syntax

[SerializableAttribute]
public class ImportExportSettings : AbstractDataContainer<ImportExportSettings>

The ImportExportSettings type exposes the following members.

Constructors

	Name	Description
Public method	ImportExportSettings	Constructor.

Properties

	Name	Description
Public property	AllowSingleExport	Indicates whether the object type supports export of individual objects from UniGrid listing pages. Default value is true when the object is exportable and logs export tasks, otherwise false.
Public property	AlwaysCheckExisting	If true, the import process always checks the existing object when importing this object type. Use for object types that may be automatically created by another object type during import, such as automatically created scheduled tasks for recalculation etc.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	ExcludedDependingType	Indicates if object is excluded depending type. Default is false.
Public property	IncludeToExportParentDataSet	Determines how the system includes objects of the type when exporting parent objects.
Public property	IncludeToWebTemplateExport	Determines the range of objects which will go to the web template export. If Default, the default selection of objects for web template export is preserved. If None, this object type will never go to web template export. If All, this object type will always go to web template export (both site and global objects). If Site, global objects are excluded. If Global, site objects are excluded.
Public property	IsAutomaticallySelected	Indicates whether all objects of the type are automatically selected when creating export packages. For internal objects that are not visible in the object tree. False by default.
Public property	IsExportable	Indicates whether the object type can be exported through regular Export/Import. False by default.
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	LogExport	Indicates whether the system logs export tasks when objects of the type are deleted. The delete tasks can be included in export packages. False by default.
Public property	LogProgress	Indicates whether the import progress log includes a record for objects of the type. True by default.
Public property	ObjectTreeLocations	Sets the locations of the object type within the object tree in the export/import wizard.
Public property	OrderBy	Order by clause that sets the order of objects in the XML data of export packages. Used to ensure that export packages containing the same objects always have matching XML data.
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	SupportsExport	Indicates whether the object type can be exported either through regular Export/Import or through SingleObjectExport.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	WhereCondition	Where condition that defines which objects of the type are available for export. Does not affect the single object export.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Property registration. (Overrides AbstractSimpleDataContainer<TObject>.RegisterColumns().)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

Remarks

Use in the ImportExportSettings property of ObjectTypeInfo.