GeneralizedInfo Class

Info object interface.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.BaseInfo.GeneralizedInfoWrapper
    CMS.DataEngine.GeneralizedInfo
      CMS.DataEngine.GeneralizedAbstractInfo

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

Syntax

public class GeneralizedInfo : BaseInfo.GeneralizedInfoWrapper

The GeneralizedInfo type exposes the following members.

Constructors

	Name	Description
Protected method	GeneralizedInfo	Constructor

Properties

	Name	Description
Public property	AllowClone	Indicates if the object supports cloning. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	AllowRestore	Indicates if the object supports deleting to recycle bin. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	AllowTouchParent	Indicates if parent is allowed to be touched, if exists. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	Bindings	The collection of the binding objects for the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	CacheParentData	If true, the parent object data is cached within object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	CheckUnique	If true, the code name is checked for uniqueness upon saving. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ChildDependencies	Collection of the child dependencies for the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	Children	The collection of the child objects for the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	CodeNameColumn	Code name column name of the info record. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ColumnNames	Column names. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	CustomizedColumns	Gets the list of customized columns in current object (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	DisplayNameColumn	Code name column name of the info record. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	HasChanged	Returns true if the object has changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	HasData	Returns true if the object has it's data storage initialized already (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IgnoreExternalColumns	If true, externally stored columns are ignored and are stored normally in DB. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsCheckedOut	Indicates if the object is checked out. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsCheckedOutByUserID	Gets ID of the user who checked the object out. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsClone	Indicates if the object is clone. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsComplete	Returns true if the object is complete (has all columns). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsDisconnected	Returns true if the object is disconnected from the data source (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	IsObjectValid	Returns true if the object is considered valid. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	Item	Gets or sets the value of the column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	LogEvents	If true, events are logged on the object update. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	LogExport	If true, export tasks are logged on the object update. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	LogIntegration	If true, integration tasks are being logged. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	LogSynchronization	If true, synchronization tasks are logged on the object update. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	LogWebFarmTasks	If true, web farm tasks are logged on the object update. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	MainObject	Main object for this general access object (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	MetaFiles	The collection of the metafiles of the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectCategory	Object category. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectCodeName	Object code name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectDisplayName	Object name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectFullName	Object full name if exists (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectGroupID	Object group ID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectGUID	Object GUID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectIcon	Object icon (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectIconGUID	Object icon GUID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectID	Object ID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectIsCustom	Indicates if object is custom (created by customer). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectIsCustomized	Indicates if object is customized. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectLastModified	Object last modified time. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectOrder	Returns the order of the object among the other objects. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectParent	Object parent (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectParentID	Object parent ID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectSiteID	Object site ID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectSiteName	Object site name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectThumbnail	Object thumbnail (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectThumbnailGUID	Object thumbnail GUID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ObjectVersionGUID	Object version GUID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	OriginalObjectCodeName	Returns the original object code name (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	OtherBindings	The collection of the other binding objects for the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ParentObjectType	Parent object type. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	PrioritizedProperties	Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	Processes	The collection of the processes of the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	Properties	Properties of the object available through GetProperty. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ReferringObjects	Collection of the objects depending on this object (object which have FK to this object). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	RelatedData	Custom data connected to the object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ScheduledTasks	The collection of the scheduled tasks of the given object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	SupportsVersioning	Indicates if the object versioning is supported. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	TouchCacheDependencies	If true, cache dependencies are touched when the object is changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	TypeInfo	Type info. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	UpdateTimeStamp	If true, time stamp is updated on object update. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	ValidateCodeName	If true, the code name is validated upon saving. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public property	VersioningEnabled	Indicates if the object versioning is enabled by the settings. (Inherited from BaseInfo.GeneralizedInfoWrapper.)

Methods

	Name	Description
Public method	AnyItemChanged	Returns true if any of the specified column names has changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	CheckDependencies	Checks object for dependent objects. Returns true if there is at least one dependent object. First tries to execute checkdependencies query, if not found, an automatic process is executed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	CheckLicense	Checks the object license. Returns true if the licensing conditions for this object were matched (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	CheckPermissions	Checks whether the specified user has permissions for this object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	Clone	Returns the clone (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	DataChanged()	Returns true if the object changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	DataChanged(String)	Returns true if the object changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	DeleteData	Deletes the object from the database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	DeleteExternalColumns	Goes through the columns which are stored externally and deletes all the files. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	DeleteObject	Deletes the object using appropriate provider. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	Disconnect	Disconnects the object from database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	EnsureBinaryData()	Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	EnsureBinaryData(Boolean)	Makes sure that the binary data is loaded into binary column of the object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	EnsureCodeName	Ensures the code name of the object if not set (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	EnsureGUID	Ensures the GUID of the object (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	EnsureUniqueCodeName	Ensures that the object has a unique code name within it's context (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	ExportDefaultData	Exports the default object installation data (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetBinaryData	Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetCacheDependencies	Gets collection of dependency keys to be touched when modifying the current object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetChildWhereCondition	Gets the child object where condition. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetColumnType	Gets the column type. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetCount	Gets count of the objects filtered by given where condition. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetData	Returns the data according to the set of input parameters. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetDataQuery	Gets the data query for this object type (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetDefaultDataWhereCondition	Gets where condition for default data according to TypeInfo configuration. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetDefaultObject	Returns default object of given object type. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetDependenciesNames	Returns a list of object names which depend on this object. First tries to execute checkdependencies query, if not found, an automatic process is executed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetDependencyObjectType	Gets dependency object type (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetExisting	Returns the existing object based on current object data. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetExternalColumns	Returns the list of columns registered as the external columns. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetExternalFiles	Goes through the columns which are stored externally and returns the list of particular files this object uses. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetFullObjectName	Returns the name of the object within its parent hierarchy. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetIconUrl	Gets the object icon URL (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetLastObjectOrder	Returns number which will be the last order within all the other items (according to Parent, Group and Site settings). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetLockObject	Gets the global lock object for all the instances of the object (locked on "objectType_objectId"). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetModifiedFrom	Gets the DataSet of all the objects modified from specified date. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetObject(Int32)	Gets the object by its ID. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetObject(String)	Gets the object by specified where condition. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetObject(IWhereCondition)	Gets the object by specified where condition. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetObjectKey	Gets the unique string key for the object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetOriginalValue	Returns the original value of column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetParent	Returns the parent object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetPhysicalFiles	Gets DataSet with physical files for current object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetProperty	Returns property with given name (either object or property value). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetPropertyType	Gets the type of the given property (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetSynchronizedColumns	Gets the list of synchronized columns for this object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetThumbnailUrl	Gets the object thumbnail URL (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetUniqueCodeName	Returns the unique code name generated from current object code name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetUniqueDisplayName	Returns the unique display name generated from current object display name. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetUniqueName	Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetValue	Returns value of column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetValueForTranslation	Returns value for translation services. Returns unmodified field content by default. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	GetVirtualFileRelativePath	Returns virtual relative path for specific column (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	InitObjectsOrder	Initializes the proper order of the sibling objects so the order column is consistent. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	InsertAsClone(CloneSettings)	Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	InsertAsClone(CloneSettings, CloneResult)	Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	InsertData	Inserts the object to the database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	Invalidate	Invalidates the object in the object table. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	IsAvailableOnSite	Checks whether info object as available on given site. Available means that object is global or assigned to given site. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	IsCheckedOutByUser	Returns true if the object is checked out by the specified user. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	IsChildOf	Returns true if the object is child of the given object. If parameter parent is null, returns true only if the object is not a child of any object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	IsModifiedExternally	Goes through the columns which are stored externally and checks if the data in DB is the same as in external storage. If all the columns are same returns true, otherwise false. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	ItemChanged	Returns true if the item on specified column name changed. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	MakeComplete	Makes the object data complete. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	MoveObjectDown	Moves the object down within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	MoveObjectUp	Moves the object up within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	NewObject	Creates new object of the given class (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Protected method	NotSupported	Throws the not supported exception (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	Reconnect	Reconnects the object to database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	RestoreSettings	Restores local settings for object instance. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	RevertChanges	Reverts the object changes to the original values. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SaveExternalColumns	Goes through the columns which are stored externally and ensures them in the external storage. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SetObject	Updates the object using appropriate provider. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SetObjectAlphabeticalOrder	Moves the object to the right position according to the custom order. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SetObjectOrder	Moves the object to the specified order (if OrderColumn is specified). The move is done within the object's parent and site (if defined). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SetValue	Sets value of column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SortAlphabetically	Moves the object to the right position according to the custom order. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	StoreSettings	Stores local settings for object instance. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	SubmitChanges	Submits the changes in the object to the database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	TouchParent	Updates the parent object by saving it (to update the timestamp). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	TryGetProperty(String, Object)	Returns property with given name (either object or property value). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	TryGetValue	Returns value of column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	UpdateData	Updates the object to the database. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	UpdateExternalColumns	Goes through the columns which are stored externally and updates DB versions with the data from external storage. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	UpdateFromDB	Updates the data of the object from DB (updates also ObjectSettings). (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	UpdatePathColumn	Updates given path column. (Inherited from BaseInfo.GeneralizedInfoWrapper.)
Public method	UpdatePhysicalFiles	Updates physical files in given DataSet for current object. (Inherited from BaseInfo.GeneralizedInfoWrapper.)