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: 10.0.0
Syntax
C#
public class TraverseObjectSettings : SynchronizationObjectSettings

The TraverseObjectSettings type exposes the following members.

Constructors
  NameDescription
Public methodTraverseObjectSettings
Top
Properties
  NameDescription
Public propertyBinary
If true, binary data is exported as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyBindingDuplicities
Gets duplicities for object bindings
(Inherited from SynchronizationObjectSettings.)
Public propertyColumns
Gets or sets COLUMNS clause.
(Inherited from SynchronizationObjectSettings.)
Public propertyCreateHierarchy
If true, result will be hierarchical (children, bindings in lower level than parent etc.).
(Inherited from SynchronizationObjectSettings.)
Public propertyDisableCollectionPaging
If true, the traversal process sets AllowPaging to false to all the collections it goes through.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocAliasPath
Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL).
(Inherited from SynchronizationObjectSettings.)
Public propertyDocClassNames
List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product").
(Inherited from SynchronizationObjectSettings.)
Public propertyDocCombineWithDefaultCulture
Specifies if return the default culture document when specified culture not found.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocConnectedObjects
Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocCoupledData
If false, coupled data are not included in the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocCultureCode
Nodes culture code.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocDeleteAllCultures
If true, all cultures are deleted when document is being deleted.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocDestroyHistory
If true, the history is deleted when the document is being deleted.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocLinkedDocuments
If true, linked documents are included in the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocSelectOnlyPublished
Select only published nodes.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocSingleDocument
If true, only single document is selected
(Inherited from SynchronizationObjectSettings.)
Public propertyDocSiteName
Nodes site name.
(Inherited from SynchronizationObjectSettings.)
Public propertyDocVersion
Version of the document to return.
(Inherited from SynchronizationObjectSettings.)
Public propertyEncoding
Gets or sets the encoding used for REST responses.
Public propertyEnsureBinaryData
If true, all the collections are forced to load binary data.
(Inherited from SynchronizationObjectSettings.)
Public propertyExcludedNames
Objects with codename or display name starting with these names will be filtered out.
Public propertyExportItemURI
Gets or sets URI of the exported item (needed for ODATA export).
(Inherited from SynchronizationObjectSettings.)
Public propertyFormat
Format of the export data (xml/json/etc.).
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.)
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeBindings
If true, binding objects are included in the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeCategories
If true, parent category hierarchy of the object is included in the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeChildren
If true, child objects are included in the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeMetadata
If true, metadata are included in the result as well.
Public propertyIncludeMetafiles
If true, metafiles of the object are included in the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeObjectData
If false, object data are not exported (true by default).
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeOtherBindings
If true, other binding objects are included in the result.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeProcesses
If true, automation processes of the object are included in the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeRelationships
If true, relationships of the object are included in the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeScheduledTasks
If true, scheduled tasks of the object are included in the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeSiteBindings
If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
(Inherited from SynchronizationObjectSettings.)
Public propertyIncludeTranslations
If true, translation table is exported within the result as well.
(Inherited from SynchronizationObjectSettings.)
Public propertyJSONCallback
Gets or sets the callback JS code used a JSONP.
(Inherited from SynchronizationObjectSettings.)
Public propertyLocalizeToLanguage
Culture code of the language to which the resulting response will be localized (if there are any localization macros - for example as a display name of the object). Null or empty string mean no localization is done to the response.
Public propertyMaxRecords
Gets or sets maximum number of records.
(Inherited from SynchronizationObjectSettings.)
Public propertyMaxRelativeLevel
Determines maximal level of the relationship (parent-child). -1 means all levels, 0 means no child objects, 1 means first level of children, etc.
(Inherited from SynchronizationObjectSettings.)
Public propertyOffset
Gets or sets offset of the records.
(Inherited from SynchronizationObjectSettings.)
Public propertyOperation
Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
(Inherited from SynchronizationObjectSettings.)
Public propertyOrderBy
Gets or sets ORDER BY clause.
(Inherited from SynchronizationObjectSettings.)
Public propertyParameter Obsolete.
Custom object passed as a parameter to export settings.
(Inherited from SynchronizationObjectSettings.)
Public propertyProcessIDCallback
Method which is called to process any FK ID.
(Inherited from SynchronizationObjectSettings.)
Public propertyProcessTranslations
If true, translation table is filled within ProcessTranslations method.
(Inherited from SynchronizationObjectSettings.)
Public propertyRequestStockKey
Returns key for request stock helper caching.
(Overrides SynchronizationObjectSettingsRequestStockKey.)
Public propertyRootName
Name of the root element of the resulting export (root of xml).
(Inherited from SynchronizationObjectSettings.)
Public propertyTopN
Gets or sets TOP N clause.
(Inherited from SynchronizationObjectSettings.)
Public propertyTranslate
If true, REST request was for translation.
Public propertyTranslationHelper
Translation helper to pass to the callback methods.
(Inherited from SynchronizationObjectSettings.)
Public propertyWhereCondition
Where condition.
(Inherited from SynchronizationObjectSettings.)
Top
See Also