ObjectHelper Class

Object manipulation methods.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.DataEngine.ObjectHelper

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

Syntax

public class ObjectHelper : CoreMethods

The ObjectHelper type exposes the following members.

Constructors

	Name	Description
Public method	ObjectHelper

Methods

	Name	Description
Public method Static member	AddDependingObjectTypes	Adds depending object types to the list.
Public method Static member	BuildFullName	Builds the full name from the given names.
Public method Static member	ExtractObjectsData	Extracts the object data from given DataSet.
Public method Static member	GetBinaryData	Gets DataSet with binary data of given files.
Public method Static member	GetBinaryDataSet	Gets empty DataSet for binary data.
Public method Static member	GetDependencyColumnName	Obsolete. Get column name of the first dependency.
Public method Static member	GetDependencyColumnNames	Get dependingObjectType dependencies: 1. parent ID column, 2. site ID column, 3. list of object dependencies where dependency object type is dependsOnObjectType object type.
Public method Static member	GetExcludedNamesWhereCondition	Generate where condition due to excluded names.
Public method Static member	GetExportSelectionColumns	Returns the list of columns needed for export selection.
Public method Static member	GetObjectFriendlyName	Returns translated name of object type.
Public method Static member	GetObjectIconPath(Page, String, String, Boolean, Boolean)	Obsolete. Gets the icon for the given object type.
Public method Static member	GetObjectIconPath(Page, String, String, Boolean, Boolean, String)	Obsolete. Gets the icon for the given object type.
Public method Static member	GetObjectIconUrl	Obsolete. Gets the icon for the given object type.
Public method Static member	GetObjectsData(GetObjectsDataSettings)	Gets the DataSet of the objects data and their child objects.
Public method Static member	GetObjectsData(OperationTypeEnum, BaseInfo, String, String, Boolean, Boolean, TranslationHelper, String[])	Gets the DataSet of the objects data and their child objects.
Public method Static member	GetObjectsData(OperationTypeEnum, GeneralizedInfo, QueryDataParameters, String, String, Boolean, Boolean, TranslationHelper, String[], Int32)	Gets the DataSet of the objects data and their child objects.
Public method Static member	GetObjectsDataSet	Returns empty objects DataSet based on the given object type.
Public method Static member	GetOtherBindingParentIdColumn	Gets the parent ID column for the given binding type info for the direction of other binding (indirect parent)
Public method Static member	GetParentIdColumn	Gets the parent ID column for the given child type in parent type
Public method Static member	GetSiteBindingObject	Gets the site binding object for specified info object.
Public method Static member	ParseFullName	Parses the full name in format "something.whatewer.abc" so that "something.whatever" is considered the first part, and "abc" second part.

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.)

Fields

	Name	Description
Public field Static member	BINARY_DATA_DEFAULT	Default binary data type.
Public field Static member	BINARY_DATA_PREVIEW	Thumbnail data type.
Public field Static member	GROUP_ADMINISTRATION	Administration object types - Group constant.
Public field Static member	GROUP_DEVELOPMENT	Development object types - Group constant.
Public field Static member	GROUP_DOCUMENTS	Document object type - Special constant.
Public field Static member	GROUP_ECOMMERCE	E-commerce object types - Group constant.
Public field Static member	GROUP_FORUMS	Forum object types - Group constant.
Public field Static member	GROUP_NEWSLETTER	Polls object types - Group constant.
Public field Static member	GROUP_NOTIFICATION	Notification object types - Group constant.
Public field Static member	GROUP_OBJECTS	All objects object type - Group constant.
Public field Static member	GROUP_OTHER	Other object types - Group constant.
Public field Static member	GROUP_PAGETEMPLATE	Page template object types - Group constant.
Public field Static member	GROUP_POLLS	Polls object types - Group constant.
Public field Static member	GROUP_REPORTING	Reporting object types - Group constant.
Public field Static member	GROUP_SITE	Site object types - Special constant.
Public field Static member	GROUP_TOOLS	Site object types - Special constant.
Public field Static member	GROUP_UICULTURE	UI culture object types - Group constant.
Public field Static member	GROUP_WEBPART	Web part object types - Group constant.

Properties

	Name	Description
Public property Static member	SkipMissingObjectTypes	Indicates if missing object types can be skipped.