Click or drag to resize
TraverseObjectSettings Class
Class encapsulating parameters for GeneralizedInfo serialization (export).
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 9.0.0
Syntax
C#
public class TraverseObjectSettings

The TraverseObjectSettings type exposes the following members.

Constructors
  NameDescription
Public methodTraverseObjectSettings
Top
Properties
  NameDescription
Public propertyBindingDuplicities
Gets duplicities for object bindings
Public propertyCreateHierarchy
If true, result will be hierarchical (children, bindings in lower level than parent etc.).
Public propertyDisableCollectionPaging
If true, the traversal process sets AllowPaging to false to all the collections it goes through.
Public propertyDocConnectedObjects
Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
Public propertyDocLinkedDocuments
If true, linked documents are included in the result.
Public propertyEnsureBinaryData
If true, all the collections are forced to load binary data.
Public propertyExcludedNames
Objects with codename or display name starting with these names will be filtered out.
Public propertyHandleBoundObjects
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 propertyIncludeBindings
If true, binding objects are included in the result.
Public propertyIncludeCategories
If true, parent category hierarchy of the object is included in the result as well.
Public propertyIncludeChildren
If true, child objects are included in the result.
Public propertyIncludeMetafiles
If true, metafiles of the object are included in the result as well.
Public propertyIncludeOtherBindings
If true, other binding objects are included in the result.
Public propertyIncludeProcesses
If true, automation processes of the object are included in the result as well.
Public propertyIncludeRelationships
If true, relationships of the object are included in the result as well.
Public propertyIncludeScheduledTasks
If true, scheduled tasks of the object are included in the result as well.
Public propertyIncludeSiteBindings
If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
Public propertyIncludeTranslations
If true, translation table is exported within the result as well.
Public propertyMaxRelativeLevel
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 propertyOperation
Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
Public propertyParameter
Custom object passed as a parameter to export settings.
Public propertyProcessArraySeparatorCallback
Method which is called when a separator should be added to a result (needed for JSON).
Public propertyProcessEndCollectionCallback
Method which is called when a level in hierarchy is finished (end of the collection).
Public propertyProcessIDCallback
Method which is called to process any FK ID.
Public propertyProcessItemCallback
Method which is called to process an item within collection.
Public propertyProcessObjectCallback
Method which is called to process info object.
Public propertyProcessStartCollectionCallback
Method which is called when new level in hierarchy is created.
Public propertyProcessTranslations
If true, translation table is filled within ProcessTranslations metod.
Public propertyRequestStockKey
Returns key for request stock helper caching.
Public propertyTranslationHelper
Translation helper to pass to the callback methods.
Top
See Also