Click or drag to resize
SynchronizationSettings Class
Class representing synchronization (staging) settings in the type information of objects.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerSynchronizationSettings
    CMS.BaseAbstractDataContainerSynchronizationSettings
      CMS.DataEngineSynchronizationSettings

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

The SynchronizationSettings type exposes the following members.

Constructors
  NameDescription
Public methodSynchronizationSettings
Top
Properties
  NameDescription
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyExcludedStagingColumns
Gets or sets the list of columns that are excluded when staging objects.
Public propertyIncludeToSynchronizationParentDataSet
Determines whether the data of parent objects automatically includes child objects of the given type during synchronization (for example staging). Applies to object types that have a parent. Set one of the values from IncludeToParentEnum. The default value is Complete for object types that have the ParentObjectType and ParentID properties set in their type info.
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyLogCondition
Condition that determines which objects of the given type generate synchronization tasks. If set, only objects that match the condition are synchronized.
Public propertyLogSynchronization
Determines whether the system logs staging tasks for objects of the type. Select one of the SynchronizationTypeEnum values.
Public propertyObjectTreeLocations
Adds the object type to the object tree on the Objects tab of the Staging application.
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertySupportsTaskOptimization
Indicates that objects of given type support staging task logging optimization.
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
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
Registers the Columns of this object
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Remarks
Use in the SynchronizationSettings property of ObjectTypeInfo.
See Also