TraverseObjectSettings Class

Class encapsulating parameters for GeneralizedInfo serialization (export).

Inheritance Hierarchy

System.Object
  CMS.DataEngine.TraverseObjectSettings
    CMS.DataEngine.ExportObjectSettings

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

Syntax

public class TraverseObjectSettings

The TraverseObjectSettings type exposes the following members.

Constructors

	Name	Description
Public method	TraverseObjectSettings

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	BindingDuplicities	Gets duplicities for object bindings
Public property	CreateHierarchy	If true, result will be hierarchical (children, bindings in lower level than parent etc.).
Public property	DisableCollectionPaging	If true, the traversal process sets AllowPaging to false to all the collections it goes through.
Public property	DocConnectedObjects	Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
Public property	DocLinkedDocuments	If true, linked documents are included in the result.
Public property	EnsureBinaryData	If true, all the collections are forced to load binary data.
Public property	ExcludedNames	Objects with codename or display name starting with these names will be filtered out.
Public property	HandleBoundObjects	If false, all bound objects (such as children or all types of bindings) are not being handled. If true, handling of these objects is determined by more specific settings (such as IncludeChildren, IncludeBindings, etc.)
Public property	IncludeBindings	If true, binding objects are included in the result.
Public property	IncludeCategories	If true, parent category hierarchy of the object is included in the result as well.
Public property	IncludeChildren	If true, child objects are included in the result.
Public property	IncludeMetafiles	If true, metafiles of the object are included in the result as well.
Public property	IncludeOtherBindings	If true, other binding objects are included in the result.
Public property	IncludeProcesses	If true, automation processes of the object are included in the result as well.
Public property	IncludeRelationships	If true, relationships of the object are included in the result as well.
Public property	IncludeScheduledTasks	If true, scheduled tasks of the object are included in the result as well.
Public property	IncludeSiteBindings	If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
Public property	IncludeTranslations	If true, translation table is exported within the result as well.
Public property	MaxRelativeLevel	Determines maximal level of the relationship (prent-child). -1 means all levels, 0 means no child objects, 1 means first level of children, etc.
Public property	Operation	Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
Public property	Parameter	Custom object passed as a parameter to export settings.
Public property	ProcessArraySeparatorCallback	Method which is called when a separator should be added to a result (needed for JSON).
Public property	ProcessEndCollectionCallback	Method which is called when a level in hierarchy is finished (end of the collection).
Public property	ProcessIDCallback	Method which is called to process any FK ID.
Public property	ProcessItemCallback	Method which is called to process an item within collection.
Public property	ProcessObjectCallback	Method which is called to process info object.
Public property	ProcessStartCollectionCallback	Method which is called when new level in hierarchy is created.
Public property	ProcessTranslations	If true, translation table is filled within ProcessTranslations metod.
Public property	RequestStockKey	Returns key for request stock helper caching.
Public property	TranslationHelper	Translation helper to pass to the callback methods.