TraverseObjectSettings MembersKentico 8.0 API Reference
The TraverseObjectSettings type exposes the following members.
Constructors

  NameDescription
Public methodTraverseObjectSettings
Back to Top
Methods

  NameDescription
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to 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.
Back to Top
See Also