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

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

The ExportObjectSettings type exposes the following members.

Constructors
  NameDescription
Public methodExportObjectSettings
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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.)
Top
Properties
  NameDescription
Public propertyBinary
If true, binary data is exported as well.
Public propertyBindingDuplicities
Gets duplicities for object bindings
(Inherited from TraverseObjectSettings.)
Public propertyColumns
Gets or sets COLUMNS clause.
Public propertyCreateHierarchy
If true, result will be hierarchical (children, bindings in lower level than parent etc.).
(Inherited from TraverseObjectSettings.)
Public propertyDisableCollectionPaging
If true, the traversal process sets AllowPaging to false to all the collections it goes through.
(Inherited from TraverseObjectSettings.)
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).
Public propertyDocClassNames
List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product").
Public propertyDocCombineWithDefaultCulture
Specifies if return the default culture document when specified culture not found.
Public propertyDocConnectedObjects
Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
(Inherited from TraverseObjectSettings.)
Public propertyDocCoupledData
If false, coupled data are not included in the result.
Public propertyDocCultureCode
Nodes culture code.
Public propertyDocDeleteAllCultures
If true, all cultures are deleted when document is being deleted.
Public propertyDocDeleteProduct
If true, the associated product is deleted with the deleted document.
Public propertyDocDestroyHistory
If true, the history is deleted when the document is being deleted.
Public propertyDocLinkedDocuments
If true, linked documents are included in the result.
(Inherited from TraverseObjectSettings.)
Public propertyDocSelectOnlyPublished
Select only published nodes.
Public propertyDocSiteName
Nodes site name.
Public propertyDocVersion
Version of the document to return.
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 TraverseObjectSettings.)
Public propertyExcludedNames
Objects with codename or display name starting with these names will be filtered out.
(Inherited from TraverseObjectSettings.)
Public propertyExportItemURI
Gets or sets URI of the exported item (needed for ODATA export).
Public propertyFormat
Format of the export data (xml/json/etc.).
Public propertyFormatResult
If true, result is formatted for better readability.
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 TraverseObjectSettings.)
Public propertyIncludeBindings
If true, binding objects are included in the result.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeCategories
If true, parent category hierarchy of the object is included in the result as well.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeChildren
If true, child objects are included in the result.
(Inherited from TraverseObjectSettings.)
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 TraverseObjectSettings.)
Public propertyIncludeObjectData
If false, object data are not exported (true by default).
Public propertyIncludeOtherBindings
If true, other binding objects are included in the result.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeProcesses
If true, automation processes of the object are included in the result as well.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeRelationships
If true, relationships of the object are included in the result as well.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeScheduledTasks
If true, scheduled tasks of the object are included in the result as well.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeSiteBindings
If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
(Inherited from TraverseObjectSettings.)
Public propertyIncludeTranslations
If true, translation table is exported within the result as well.
(Inherited from TraverseObjectSettings.)
Public propertyJSONCallback
Gets or sets the callback JS code used a JSONP.
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.
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.
(Inherited from TraverseObjectSettings.)
Public propertyOffset
Gets or sets offset of the records.
Public propertyOperation
Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
(Inherited from TraverseObjectSettings.)
Public propertyOrderBy
Gets or sets ORDER BY clause.
Public propertyParameter
Custom object passed as a parameter to export settings.
(Inherited from TraverseObjectSettings.)
Public propertyProcessArraySeparatorCallback
Method which is called when a separator should be added to a result (needed for JSON).
(Inherited from TraverseObjectSettings.)
Public propertyProcessEndCollectionCallback
Method which is called when a level in hierarchy is finished (end of the collection).
(Inherited from TraverseObjectSettings.)
Public propertyProcessIDCallback
Method which is called to process any FK ID.
(Inherited from TraverseObjectSettings.)
Public propertyProcessItemCallback
Method which is called to process an item within collection.
(Inherited from TraverseObjectSettings.)
Public propertyProcessObjectCallback
Method which is called to process info object.
(Inherited from TraverseObjectSettings.)
Public propertyProcessStartCollectionCallback
Method which is called when new level in hierarchy is created.
(Inherited from TraverseObjectSettings.)
Public propertyProcessTranslations
If true, translation table is filled within ProcessTranslations metod.
(Inherited from TraverseObjectSettings.)
Public propertyRequestStockKey
Returns key for request stock helper caching.
(Overrides TraverseObjectSettingsRequestStockKey.)
Public propertyRootName
Name of the root element of the resulting export (root of xml).
Public propertyTopN
Gets or sets TOP N clause.
Public propertyTranslate
If true, REST request was for translation.
Public propertyTranslationHelper
Translation helper to pass to the callback methods.
(Inherited from TraverseObjectSettings.)
Public propertyWhere
Gets or sets WHERE condition.
Top
See Also