SynchronizationSettings Class

Class representing synchronization (staging) settings in the type information of objects.

Inheritance Hierarchy

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

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

Syntax

[SerializableAttribute]
public class SynchronizationSettings : AbstractDataContainer<SynchronizationSettings>

The SynchronizationSettings type exposes the following members.

Constructors

	Name	Description
Public method	SynchronizationSettings

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	IncludeToSynchronizationParentDataSet	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 property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	LogCondition	Condition that determines which objects of the given type generate synchronization tasks. If set, only objects that match the condition are synchronized.
Public property	LogSynchronization	Determines whether the system logs staging tasks for objects of the type. Select one of the SynchronizationTypeEnum values.
Public property	ObjectTreeLocations	Adds the object type to the object tree on the Objects tab of the Staging application.
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	SynchronizedColumns	Limits which fields are included when updating existing objects via synchronization (staging). List collection of field names (as a whitelist). If not set, all fields are synchronized.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)

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	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
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 SynchronizationSettings property of ObjectTypeInfo.