GetObjectsDataSettings Class

Configuration class for GetObjectsData(GetObjectsDataSettings).

Inheritance Hierarchy

System.Object
  CMS.DataEngine.GetObjectsDataSettings

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

Syntax

public class GetObjectsDataSettings

The GetObjectsDataSettings type exposes the following members.

Constructors

	Name	Description
Public method	GetObjectsDataSettings	Constructor of the configuration class.

Methods

	Name	Description
Public method	Clone	Creates clone of current settings object.

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	ExcludedNames	List of names which are used to filter out objects having codename or display name that starts with one of these names.
Public property	IncludeBinaryData	Indicates if binary data should be included into selection.
Public property	IncludeChildData	Indicates if child object data should be included into selection.
Public property	InfoObject	Main info object for which the data should be retrieved.
Public property	Operation	Operation type.
Public property	OrderBy	Order by.
Public property	QueryParameters	Query parameters for the selection.
Public property	SiteId	Site ID specifies that only site child objects and bindings are included into selection.
Public property	TranslationTable	Translation table to initialize with data bindings.
Public property	Where	Where condition.