Click or drag to resize
ImportExportSettings Class
Class representing export/import settings in the type information of objects.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerImportExportSettings
    CMS.BaseAbstractDataContainerImportExportSettings
      CMS.DataEngineImportExportSettings

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
[SerializableAttribute]
public class ImportExportSettings : AbstractDataContainer<ImportExportSettings>

The ImportExportSettings type exposes the following members.

Constructors
  NameDescription
Public methodImportExportSettings
Constructor.
Top
Properties
  NameDescription
Public propertyAllowSingleExport
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 propertyAlwaysCheckExisting
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 propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyExcludedDependingType
Indicates if object is excluded depending type. Default is false.
Public propertyIncludeToExportParentDataSet
Determines how the system includes objects of the type when exporting parent objects.
Public propertyIncludeToWebTemplateExport
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 propertyIsAutomaticallySelected
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 propertyIsExportable
Indicates whether the object type can be exported through regular Export/Import. False by default.
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyLogExport
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 propertyLogProgress
Indicates whether the import progress log includes a record for objects of the type. True by default.
Public propertyObjectTreeLocations
Sets the locations of the object type within the object tree in the export/import wizard.
Public propertyOrderBy
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 propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertySupportsExport
Indicates whether the object type can be exported either through regular Export/Import or through SingleObjectExport.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyWhereCondition
Where condition that defines which objects of the type are available for export. Does not affect the single object export.
Top
Methods
  NameDescription
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Property registration.
(Overrides AbstractSimpleDataContainerTObjectRegisterColumns.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Remarks
Use in the ImportExportSettings property of ObjectTypeInfo.
See Also