Click or drag to resize
BaseInfo Methods

The BaseInfo type exposes the following members.

Methods
  NameDescription
Protected methodAddColumnPrefixesWhereCondition
Adds restriction to given where filtering out all rows where given column starts with one of excluded prefixes found in TypeInfo default data settings.
Protected methodStatic memberAddDependencyDefaultDataWhereCondition
Adds default data where condition of given dependency on given dependencyIDColumn to given where condition. Returns original where condition if no such dependency exists.
Protected methodBuildObjectPath
Builds the path from the given column.
Public methodStatic memberClear
Clears hashtable with cached properties of all object types.
Protected methodClearCache
Clears the nested cached objects
Public methodClearData
Clears data from the object.
Protected methodCloneObject
Creates the clone of the object
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodContainsColumn
Returns true if the object contains given column.
Protected methodCopyExternalColumns
Copy value of external columns directly via set value
Protected methodCopyMemoryProperties
Copies memory properties
Public methodDataChanged
Returns true if the object changed.
Public methodDelete
Deletes the object using appropriate provider
Protected methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
Protected methodDeleteObject
Deletes the object using appropriate provider.
Public methodDestroy
Destroys the object including its version history using appropriate provider
Protected methodDisconnect
Disconnects the collection from the database.
Protected methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
Protected methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
Protected methodEnsureCodeName
Ensures the code name of the object if not set
Protected methodEnsureGUID
Ensures the GUID of the object
Protected methodEnsureHierarchyColumns
Ensures the IDPath and Level columns.
Protected methodEnsureLastModified
Ensures the last modified time stamp of the object
Protected methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
Protected methodExecuteRemoveDependencyQuery
Executes given query text using specified connection string.
Protected methodExportDefaultData
Exports the default object installation data
Protected methodFinalize
Destructor
(Overrides ObjectFinalize.)
Protected methodGetAutomaticCodeName
Gets the automatic code name for the object
Protected methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overriden by specific classes. Returns null by default.
Public methodGetBooleanValue
Gets the boolean value from the object.
Protected methodGetCount
Gets count of the objects filtered by given where condition.
Protected methodGetCurrentObjectPathPart
Builds the path from the given column.
Protected methodGetCustomProperties
Gets list of custom properties.
Protected methodGetData
Returns the data according to the set of input parameters.
Protected methodGetDataQueryInternal
Gets the data query for this object type
Public methodGetDateTimeValue
Gets the DateTime value from the object.
Protected methodGetDefaultData
Returns the default object installation data
Protected methodGetDefaultDataExportColumns
Returns names of all columns that should be exported with default data as a comma separated string.
Protected methodGetDefaultDataWhereCondition
Gets the where condition to filter out the default installation data
Protected methodGetDefaultObject
Returns default object of given object type. Has to be overriden in specific info. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
Protected methodGetDependenciesNames
Checks the object dependencies. 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.
Protected methodGetDependenciesNamesAuto
Checks the object dependencies. Returns a list of object names which depend on this object.
Protected methodGetDependencyCacheKeys
Gets the array of dependency cache keys for current object.
Public methodGetDependencyObjectType
Gets dependency object type
Public methodGetDoubleValue
Gets the double value from the object.
Protected methodGetEditingPageURL
Gets the object editing page URL.
Protected methodGetExisting
Returns the existing object based on current object data.
Protected methodGetExistingWhereCondition
Gets a where condition to find an existing object based on current object
Protected methodGetExistingWhereCondition(Boolean)
Gets a where condition to find an existing object based on current object
Protected methodGetExternalColumns
Returns the list of columns registered as the external columns.
Protected methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
Protected methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
Protected methodGetGeneralizedInfo
Gets the generalized info for this object
Protected methodGetGlobalPermissionName
Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
Protected methodGetGroupWhereCondition
Gets the group where condition for the object
Public methodGetGuidValue
Gets the guid value from the object.
Protected methodGetChildDependencies
Gets the child dependencies repository
Protected methodGetChildWhereCondition
Gets the child object where condition.
Protected methodGetIconUrl(Page, String)
Gets the object icon URL
Protected methodGetIconUrl(Int32, Int32, Int32)
Gets the object icon URL
Protected methodGetIdentityWhereCondition
Gets indentity where condition to identify the object
Protected methodGetIDPathPartLength
Returns the length of a part of IDPath.
Public methodGetIntegerValue
Gets the integer value from the object.
Protected methodGetLastObjectOrder
Returns number which will be the last order within all the other items (according to Parent, Group and Site settings). I.e. returns largest existing order + 1.
Protected methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
Protected methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
Protected methodGetNameCollisions
Gets the list of the name collisions of the given object
Protected methodGetNamePathPartColumn
Returns the name of the column which is used to build the NamePath
Protected methodGetObject
Gets the object by specified where condition.
Public methodGetObjectData
Object serialization.
Protected methodGetObjectChildren
Gets the object children repository
Protected methodGetObjectIdentifier
Gets the object identifier that uniquely identifies the object
Protected methodGetObjectKey
Gets the unique string key for the object.
Protected methodGetObjectOrderID
Returns ID of the item being ordered. By default return ObjectID. This is overridden in TreeNode, where NodeID has to be supplied.
Protected methodGetObjectTypeForColumn
Gets the object type for the given column or null if the object type is not found or unknown.
Protected methodGetOrderQueryParameters
Creates QueryDataParameters with special macros for object order management.
Public methodGetOriginalValue
Returns the original value of column.
Protected methodGetOtherBindings
Gets the repository of other bindings
Protected methodGetParent
Returns the parent object.
Protected methodGetPermissionName
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
Protected methodGetPermissionObjectType
Returns the permission object type of the object (checks the SiteID column and SiteBinding columns). According to this value, the permission check is performed.
Protected methodGetPermissionToCheck
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
Protected methodGetPhysicalFiles
Gets DataSet with physical files.
Public methodGetProperty
Gets the property value.
Protected methodGetPropertyType
Gets the type of the given property
Protected methodGetReferringObjects
Gets the repository of depending objects
Protected methodGetRegisteredProperties
Gets list of registered properties.
Public methodGetSearchID
Gets the id column value which is used as search id by default.
Protected methodGetSiblingsQueryInternal
Gets the parametrized query to get siblings of the object (If there is no parent-child hierarchy, query is parametrized for all objects)
Protected methodGetSiblingsWhereCondition
Creates where condition according to Parent, Group and Site settings.
Protected methodGetSiteWhereCondition
Gets the site where condition for the object
Public methodGetStringValue
Gets the string value from the object.
Protected methodGetThumbnailUrl
Gets the object thumbnail URL
Protected methodGetUniqueCodeName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected methodGetUniqueDisplayName
Returns the unique display name for the specified object.
Protected methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Protected methodGetUniqueNameWhereCondition
Constructs base where condition for checking column value uniqueness. This method can be overriden in child classes to add more conditions.
Public methodGetValue
Gets the object value.
Protected methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
Protected methodGetVirtualFileRelativePath
Returns virtual relative path for specific column Ensures the GUID of the object
Public methodChangedColumns
Returns list of column names which values were changed.
Protected methodCheckDefaultPermissions
Check universal permissions for an object
Protected methodCheckDependencies
Checks the object dependencies. Returns true if there is at least one dependency.
Protected methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched.
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
Protected methodCheckPermissionsInternal
Checks whether the specified user has permissions for this object. This method is called automatically after CheckPermissions event was fired.
Protected methodCheckPermissionsWithHandler
Checks whether the specified user has permissions for this object. Outcome of this method is determined by combining results of CheckPermissions event and CheckPermissionsInternal method.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
Protected methodInitObjectsOrder
Inits the proper item order so the order is consistent.
Protected methodInitObjectsOrderPostprocessing
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization. Does nothing by default.
Public methodInsert
Inserts the object using appropriate provider
Protected methodInsertAsClone
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
Protected methodInsertAsCloneInternal
This method is called on cloned object prepared in memory by InsertAsClone method. Override if you need to do further actions before inserting actual object to DB (insert special objects, modify foreign keys, copy files, etc.). Calls Insert() by default.
Protected methodInsertAsClonePostprocessing
This method is called once the object is completely cloned (with all children, bindings, etc.). Override if you need to do further actions after the object has been cloned.
Protected methodInvalidate
Invalidates the object in the object table.
Protected methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
Protected methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
Protected methodIsChildOf
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.
Protected methodIsModifiedExternally
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.
Protected methodIsObjectInvalid
Returns true if the object is invalid.
Public methodItemChanged
Returns true if the item on specified column name changed.
Protected methodLoadFromDataContainer
Loads the object from the given data container
Protected methodLoadFromDataRow
Loads the object from the given DataRow
Public methodMacroRepresentation
By default, BaseInfo has no special macro representation.
Public methodMakeComplete
Makes the object data complete.
Protected methodPermissionCheckException
Fires an exception in case authorization result is false (denied or insignificant)
Public methodPropertyPropertyType
Returns the extension property for the object
(Inherited from AbstractObject.)
Protected methodReconnect
Reconnects the collection to the database.
Protected methodRemoveObjectDependencies
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
Protected methodRestoreSettings
Restores local settings for object instance.
Protected methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
Protected methodSerializationNotSupported
Throws serialization not supported exception
Protected methodSetObject
Updates the object using appropriate provider.
Protected methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
Protected methodSetObjectOrder
Moves the object to the specified order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
Protected methodSetObjectOrderPostprocessing
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
Protected methodSetParent
Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
Public methodSetValue(String, Object)
Sets the object value.
Public methodSetValue(String, Object, Boolean)
Sets the object value to the nullable column.
Public methodSetValue(String, Object, Object)
Sets the object value to the nullable column.
Protected methodSortAlphabetically
Sort objects alphabetically.
Protected methodStoreSettings
Stores local settings for object instance.
Public methodSubmitChanges
Submits the changes in the object to the database.
Public methodToMacroString
Returns the default text representation in the macros.
Public methodToString
Returns the text representation of the object
(Overrides ObjectToString.)
Protected methodTouchParent
Updates the parent object by saving it (to update the timestamp).
Public methodTryGetProperty(String, Object)
Returns value of property.
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
Public methodTryGetValue
Returns value of column.
Public methodUpdate
Updates the database entity using appropriate provider
Protected methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
Protected methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
Protected methodUpdatePhysicalFiles
Saves physical files.
Protected methodWriteDefaultData
Writes the default object installation data into xml file
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 MethodCompare
Compares two BaseInfo objects (data & structure) according to comparison settings given.
(Defined by DataExtensions.)
Public Extension MethodCopyTo
Copies the data of specified columns of the source object to the target object.
(Defined by DataExtensions.)
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 MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
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 MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Top
See Also