Click or drag to resize
AbstractInfoBaseTInfo Methods

The AbstractInfoBaseTInfo generic 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.
(Inherited from BaseInfo.)
Protected methodAllowExternalColumn
Indicates whether a given column is allowed to be saved externally.
Public methodAnyItemChanged
Returns true if any of specified columns changed.
Protected methodBuildObjectPath
Builds the path from the given column.
(Inherited from BaseInfo.)
Protected methodClearCache
Clears the nested cached objects
(Inherited from BaseInfo.)
Protected methodClearCachedValues
Clears the cached values depending on the given column value.
(Inherited from BaseInfo.)
Public methodClearData
Clears data from the object.
(Inherited from BaseInfo.)
Public methodClone
Creates a clone of the object
Public methodClone(Boolean)
Creates a clone of the object
Public methodCloneObject
Creates the clone of the object
(Overrides BaseInfoCloneObject(Boolean).)
Protected methodColumnsChanged
Returns true if at least one column of the column list provided as the first argument was changed.
Protected methodCombineColumnNames(ICollection)
Combines column names from supplied collections into a list and caches it in mCombinedColumnNames. Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true. Returns combined column names.
Public methodCombineColumnNames(String)
Combines supplied column names into a list and caches it in mCombinedColumnNames. Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true. Returns combined column names.
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.
(Inherited from BaseInfo.)
Public methodContainsColumn
Returns true if the object contains given column.
(Overrides BaseInfoContainsColumn(String).)
Protected methodCopyExternalColumns
Copy value of external columns directly via set value
(Inherited from BaseInfo.)
Protected methodCopyMemoryProperties
Copies memory properties
(Inherited from BaseInfo.)
Protected methodCopyProperties
Copies memory properties
Public methodDataChanged
Returns true if the object changed.
(Overrides BaseInfoDataChanged(String).)
Public methodDelete
Deletes the object using appropriate provider
(Inherited from BaseInfo.)
Protected methodDeleteData
Deletes the object.
Protected methodDeleteDataInternal
Deletes the object data from the database
Protected methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
(Overrides BaseInfoDeleteExternalColumns(Boolean).)
Protected methodDeleteMetafiles
Deletes the metafiles related to this object
Protected methodDeleteObject
Deletes the object using appropriate provider.
(Overrides BaseInfoDeleteObject.)
Public methodDestroy
Destroys the object including its version history using appropriate provider
(Inherited from BaseInfo.)
Protected methodDisconnect
Disconnects the collection from the database.
(Inherited from BaseInfo.)
Protected methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
(Inherited from BaseInfo.)
Protected methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
(Inherited from BaseInfo.)
Protected methodEnsureCodeName
Ensures the code name of the object if not set
(Inherited from BaseInfo.)
Protected methodEnsureData
Creates a new data class container within the object
Protected methodEnsureGUID
Ensures the GUID of the object
(Inherited from BaseInfo.)
Protected methodEnsureHierarchyColumns
Ensures the IDPath and Level columns.
(Inherited from BaseInfo.)
Protected methodEnsureLastModified
Ensures the last modified time stamp of the object
(Inherited from BaseInfo.)
Protected methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
(Inherited from BaseInfo.)
Public methodExecuteWithOriginalData
Executes the given action using original data of the object.
(Overrides BaseInfoExecuteWithOriginalData(Action).)
Protected methodExportDefaultData
Exports the default object installation data
(Inherited from BaseInfo.)
Protected methodFinalize
Destructor
(Inherited from BaseInfo.)
Protected methodGetAutomaticCodeName
Gets the automatic code name for the object
(Inherited from BaseInfo.)
Protected methodGetAutomaticProperty
Tries to get the automatic property value for underlying object
Protected methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
(Inherited from BaseInfo.)
Public methodGetBooleanValue
Gets the boolean value from the object.
(Inherited from BaseInfo.)
Protected methodGetColumnNames
Gets the default list of column names for this class
(Overrides BaseInfoGetColumnNames.)
Protected methodGetCount
Gets count of the objects filtered by given where condition.
(Inherited from BaseInfo.)
Protected methodGetCurrentObjectPathPart
Builds the path from the given column.
(Inherited from BaseInfo.)
Protected methodGetCustomProperties
Gets list of custom properties.
(Inherited from BaseInfo.)
Protected methodGetData
Returns the data according to the set of input parameters.
(Inherited from BaseInfo.)
Protected methodGetDataQueryInternal
Gets the data query for this object type
(Inherited from BaseInfo.)
Public methodGetDateTimeValue
Gets the DateTime value from the object.
(Inherited from BaseInfo.)
Protected methodGetDefaultData
Returns the default object installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultDataExportColumns
Returns names of all columns that should be exported with default data as a comma separated string.
(Inherited from BaseInfo.)
Protected methodGetDefaultDataWhereCondition
Gets the where condition to filter out the default installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultObject
Returns default object of given object type. Has to be overridden in specific info. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
(Inherited from BaseInfo.)
Protected methodGetDependenciesNames
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.)
Protected methodGetDependenciesNamesAuto
Returns a list of object names which depend on this object.
(Inherited from BaseInfo.)
Protected methodGetDependencyCacheKeys
Gets collection of dependency keys to be touched when modifying the current object.
(Inherited from BaseInfo.)
Public methodGetDependencyObjectType
Gets dependency object type
(Inherited from BaseInfo.)
Public methodGetDoubleValue
Gets the double value from the object.
(Inherited from BaseInfo.)
Protected methodGetEditingPageURL
Gets the object editing page URL.
(Inherited from BaseInfo.)
Protected methodGetExisting
Returns the existing object based on current object data.
(Inherited from BaseInfo.)
Protected methodGetExistingBase
Returns single info object and ensures correct GUID vs. code name priority is used (if applicable) after resolving provided whereCondition.

If no object match provided whereCondition, null is returned.

(Inherited from BaseInfo.)
Protected methodGetExistingWhereCondition
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.)
Protected methodGetExistingWhereCondition(Boolean)
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.)
Protected methodGetExternalColumnData
Returns the column data from external storage if exists.
Protected methodGetExternalColumns
Returns the list of columns registered as the external columns.
(Overrides BaseInfoGetExternalColumns.)
Protected methodGetExternalColumnSettings
Returns settings for external storage of the column. Returns null by default (which causes the default settings to be used in the external column data storage process).
Protected methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
(Overrides BaseInfoGetExternalFiles.)
Protected methodGetExternalPath
Returns path to the external storage with data of the given column. If the column data is not stored in the external storage (not enabled), and the check for enabled is allowed, returns null.
Public methodGetFileInfo
Returns FileInfo object from external storage if exists.
Protected methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
(Inherited from BaseInfo.)
Protected methodGetGeneralizedInfo
Gets the generalized info for this object
(Overrides BaseInfoGetGeneralizedInfo.)
Protected methodGetGlobalPermissionName
Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
(Inherited from BaseInfo.)
Protected methodGetGroupWhereCondition
Gets the group where condition for the object
(Inherited from BaseInfo.)
Public methodGetGuidValue
Gets the guid value from the object.
(Inherited from BaseInfo.)
Protected methodGetChildDependencies
Gets the child dependencies repository
(Inherited from BaseInfo.)
Protected methodGetChildWhereCondition
Gets the child object where condition.
(Inherited from BaseInfo.)
Protected methodGetIconUrl
Gets the object icon URL
(Inherited from BaseInfo.)
Protected methodGetIDPathPartLength
Returns the length of a part of IDPath.
(Inherited from BaseInfo.)
Public methodGetIntegerValue
Gets the integer value from the object.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
Protected methodGetLocalColumnNames
Gets the list of local column names for particular object
Protected methodGetLocalProperties
Gets the list of local properties for particular object
Protected methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
(Inherited from BaseInfo.)
Protected methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
(Inherited from BaseInfo.)
Protected methodGetNameCollisions
Gets the list of the name collisions of the given object
(Inherited from BaseInfo.)
Protected methodGetNamePathPartColumn
Returns the name of the column which is used to build the NamePath
(Inherited from BaseInfo.)
Public methodGetObject(Int32)
Gets the object by its ID.
(Inherited from BaseInfo.)
Protected methodGetObject(IWhereCondition, Boolean)
Gets the object by specified where condition.
(Inherited from BaseInfo.)
Public methodGetObjectData
Object serialization.
(Overrides BaseInfoGetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetObjectChildren
Gets the object children repository
(Inherited from BaseInfo.)
Protected methodGetObjectIdentifier
Gets the object identifier that uniquely identifies the object
(Inherited from BaseInfo.)
Protected methodGetObjectKey
Gets the unique string key for the object.
(Inherited from BaseInfo.)
Protected methodGetObjectName
Returns object name combining object type name and object display name.
(Inherited from BaseInfo.)
Protected methodGetObjectOrderID
Returns ID of the item being ordered. By default return ObjectID. This is overridden in TreeNode, where NodeID has to be supplied.
(Inherited from BaseInfo.)
Protected methodGetObjectTypeForColumn
Gets the object type for the given column or null if the object type is not found or unknown.
(Inherited from BaseInfo.)
Protected methodGetOrderIdentityWhereCondition
Gets order identity where condition to identify the object to be ordered
(Inherited from BaseInfo.)
Protected methodGetOrderQueryParameters
Creates QueryDataParameters with special macros for object order management.
(Inherited from BaseInfo.)
Public methodGetOriginalValue
Returns the original value of column.
(Overrides BaseInfoGetOriginalValue(String).)
Protected methodGetOtherBindings
Gets the repository of other bindings
(Inherited from BaseInfo.)
Protected methodGetParent
Returns the parent object.
(Inherited from BaseInfo.)
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).
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
Protected methodGetPermissionToCheck
Gets permission to check for the object. By default the Create and Delete permission is changed to Modify.
(Inherited from BaseInfo.)
Protected methodGetPhysicalFiles
Gets DataSet with physical files.
(Inherited from BaseInfo.)
Public methodGetProperty
Gets the property value.
(Inherited from BaseInfo.)
Protected methodGetPropertyType
Gets the type of the given property
(Overrides BaseInfoGetPropertyType(String).)
Protected methodGetReferringObjects
Gets the repository of depending objects
(Inherited from BaseInfo.)
Protected methodGetRegisteredProperties
Gets list of registered properties.
(Overrides BaseInfoGetRegisteredProperties.)
Public methodGetSearchDocument
Returns index document for current object with dependencies on search index info.
Public methodGetSearchFields
Returns search fields collection. When existing collection is passed as argument, fields will be added to that collection. When collection is not passed, new collection will be created and return. Collection will contain field values only when collection with StoreValues property set to true is passed to the method. When method creates new collection, it is created with StoreValues property set to false.
Public methodGetSearchID
Gets the id column value which is used as search id by default.
(Inherited from BaseInfo.)
Public methodGetSearchImageUrl
Returns URL to current search result item.
Protected methodGetSiblingsQueryInternal
Gets the parameterized query to get siblings of the object (If there is no parent-child hierarchy, query is parameterized for all objects)
(Inherited from BaseInfo.)
Protected methodGetSiblingsWhereCondition
Creates where condition according to Parent, Group and Site settings.
(Inherited from BaseInfo.)
Protected methodGetSiteWhereCondition
Gets the site where condition for the object
(Inherited from BaseInfo.)
Public methodGetStringValue
Gets the string value from the object.
(Inherited from BaseInfo.)
Protected methodGetSynchronizedColumns
Gets the list of synchronized columns for this object.
(Inherited from BaseInfo.)
Protected methodGetThumbnailUrl
Gets the object thumbnail URL
(Inherited from BaseInfo.)
Protected methodGetUniqueCodeName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueDisplayName
Returns the unique display name for the specified object.
(Inherited from BaseInfo.)
Protected methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueNameWhereCondition
Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
(Inherited from BaseInfo.)
Public methodGetValue(String)
Gets the field value.
(Overrides BaseInfoGetValue(String).)
Public methodGetValueT(String, T)
Gets the field value converted to a specified type.
Protected methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
(Inherited from BaseInfo.)
Protected methodGetVirtualFileRelativePath
Returns virtual relative path for specific column Ensures the GUID of the object
(Inherited from BaseInfo.)
Protected methodHasAutomaticProperty
Returns true if the given column provides an automatic property to access it's binding.
Public methodChangedColumns
Returns list of column names which values were changed.
(Overrides BaseInfoChangedColumns.)
Protected methodCheckDefaultPermissions
Check universal permissions for an object
(Inherited from BaseInfo.)
Protected methodCheckDependencies
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.)
Protected methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched.
(Inherited from BaseInfo.)
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
(Inherited from BaseInfo.)
Protected methodCheckPermissionsInternal
Checks whether the specified user has permissions for this object. This method is called automatically after CheckPermissions event was fired.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
Protected methodInitObjectsOrder
Inits the proper order of the sibling objects so the order column is consistent.
(Inherited from BaseInfo.)
Protected methodInitObjectsOrderPostprocessing
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization.
(Inherited from BaseInfo.)
Public methodInsert
Inserts the object using appropriate provider
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
Protected methodInsertData
Inserts the object to the database.
Protected methodInsertDataInternal
Inserts the object data to the database
Protected methodInvalidate
Invalidates the object in the object table.
(Inherited from BaseInfo.)
Protected methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
(Inherited from BaseInfo.)
Protected methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
(Inherited from BaseInfo.)
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.
(Inherited from BaseInfo.)
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.
(Overrides BaseInfoIsModifiedExternally.)
Protected methodIsObjectInvalid
Returns true if the object is invalid.
(Inherited from BaseInfo.)
Public methodItemChanged
Returns true if the item on specified column name changed.
(Overrides BaseInfoItemChanged(String).)
Protected methodLoadData
Loads the object using the given settings
(Overrides BaseInfoLoadData(LoadDataSettings).)
Protected methodLoadDefaultData
Loads the default data to the object.
Public methodMacroRepresentation
By default, BaseInfo has no special macro representation.
(Inherited from BaseInfo.)
Public methodMakeComplete
Makes the object data complete.
(Overrides BaseInfoMakeComplete(Boolean).)
Protected methodStatic memberNewInternal
Creates a new object of the given object type
Protected methodNewObject
Creates new object of the given class based on the given settings
(Inherited from BaseInfo.)
Protected methodPermissionCheckException
Fires an exception in case authorization result is false (denied or insignificant)
(Inherited from BaseInfo.)
Public methodPropertyPropertyType
Returns the extension property for the object
(Inherited from AbstractObject.)
Protected methodReconnect
Reconnects the collection to the database.
(Inherited from BaseInfo.)
Protected methodRegisterExternalColumn
Registers external column settings to the hash table.
Protected methodRegisterExternalColumns
Registers external column settings to the hash table.
Protected methodRegisterProperties
Registers the properties of this object
Protected methodRegisterProperty(String, FuncTInfo, Object)
Registers the given property to the object
Protected methodRegisterProperty(String, Object, FuncTInfo, Object, Object)
Registers the given parametrized property to the object.
Protected methodRegisterPropertyTProperty(String, FuncTInfo, Object)
Registers the given property to the object
Protected methodRemoveObjectDependencies
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
(Inherited from BaseInfo.)
Public methodStatic memberReplaceWithTNewInfo
Initiates the system to replace the info type with a specified type that must inherit from the original info type
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged according to the asUnchanged parameter.
(Overrides BaseInfoResetChanges.)
Protected methodRestoreSettings
Restores local settings for object instance.
(Inherited from BaseInfo.)
Public methodRevertChanges
Reverts the object changes to the original values.
(Overrides BaseInfoRevertChanges.)
Protected methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
(Overrides BaseInfoSaveExternalColumns(Boolean, Boolean).)
Protected methodSerializationNotSupported
Throws serialization not supported exception
(Inherited from BaseInfo.)
Protected methodSetData
Updates or inserts the object to the database.
Protected methodSetExternalColumnData
Saves the column data to the external storage if exists. Returns true if data was stored in external storage and should not be stored also in DB. If data should be stored in DB, returns false.
Protected methodSetObject
Updates the object using appropriate provider.
(Overrides BaseInfoSetObject.)
Protected methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
(Inherited from BaseInfo.)
Protected methodSetObjectOrder
Moves the object to the specified order. The move is done within the object's siblings.
(Inherited from BaseInfo.)
Protected methodSetObjectOrderPostprocessing
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
(Overrides BaseInfoSetObjectOrderPostprocessing.)
Protected methodSetParent
Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
(Inherited from BaseInfo.)
Protected methodSetReadOnly
Locks the object as a read-only
(Overrides BaseInfoSetReadOnly.)
Public methodSetValue(String, Object)
Sets the field value.
(Overrides BaseInfoSetValue(String, Object).)
Public methodSetValue(String, Object, Boolean)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Public methodSetValue(String, Object, Object)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Protected methodSortAlphabetically
Sort objects alphabetically.
(Inherited from BaseInfo.)
Protected methodStoreSettings
Stores local settings for object instance.
(Inherited from BaseInfo.)
Public methodSubmitChanges
Submits the changes in the object to the database.
(Inherited from BaseInfo.)
Public methodToMacroString
Returns the default text representation in the macros.
(Inherited from BaseInfo.)
Public methodToString
Returns the text representation of the object
(Inherited from BaseInfo.)
Public methodTouchKeys
Touches the cache dependency keys of the object to flush the dependent cache items.
Protected methodTouchParent
Updates the parent object by saving it (to update the timestamp).
(Inherited from BaseInfo.)
Protected methodTryGetAutomaticProperty
Tries to get the automatic property value for underlying object
Public methodTryGetProperty(String, Object)
Returns value of property.
(Overrides BaseInfoTryGetProperty(String, Object).)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from BaseInfo.)
Public methodTryGetValue
Returns value of column.
(Overrides BaseInfoTryGetValue(String, Object).)
Public methodUpdate
Updates the database entity using appropriate provider
(Inherited from BaseInfo.)
Protected methodUpdateData
Updates the object to the database.
Protected methodUpdateDataInternal
Updates the object data to the database
Protected methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
(Overrides BaseInfoUpdateExternalColumns.)
Protected methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
(Inherited from BaseInfo.)
Protected methodUpdatePhysicalFiles
Saves physical files.
(Inherited from BaseInfo.)
Protected methodUpsertData
Updates or inserts the object to the database.
Protected methodUpsertDataInternal
Upserts the data to the database
Protected methodWriteDefaultData
Writes the default object installation data into xml file
(Inherited from BaseInfo.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddContentField
Process search settings of DataClass field and inserts required search field into search fields collection when field is marked as content field.
(Defined by SearchableExtensions.)
Public Extension MethodAddSearchableField
Process search settings of DataClass field and inserts required search field into search fields collection when field is searchable.
(Defined by SearchableExtensions.)
Public Extension MethodCompare
Compares two BaseInfo objects (data & structure) according to comparison settings given.
(Defined by DataExtensions.)
Public Extension MethodSerialize
Returns object data serialized into the XML element.
(Defined by SerializationExtensions.)
Top
See Also