Click or drag to resize
AbstractImportExportSettings Class
Abstract class for import and export settings.
Inheritance Hierarchy

Namespace: CMS.CMSImportExport
Assembly: CMS.ImportExport (in CMS.ImportExport.dll) Version: 12.0.0
Syntax
C#
[SerializableAttribute]
public class AbstractImportExportSettings : ISerializable

The AbstractImportExportSettings type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractImportExportSettings(IUserInfo)
Constructor - Creates abstract settings.
Public methodAbstractImportExportSettings(SerializationInfo, StreamingContext)
Constructor - Constructor for deserialization.
Top
Fields
  NameDescription
Protected fieldmCurrentUser
Current user info.
Protected fieldmDefaultProcessObjectType
Default object process type.
Protected fieldmEventLog
Event log object.
Protected fieldmEventLogCode
Event log code.
Protected fieldmEventLogSource
Event log source.
Protected fieldmExcludedNames
Excludes object names.
Protected fieldmInfoDataSet
Data set with additional information.
Protected fieldmPersistentSettingsKey
Persistent key to store the settings.
Protected fieldmProcessCanceled
Flag for process cancelation.
Protected fieldmProcessGlobalObjectsHashtable
Hashtable with lists of global objects to be processed.
Protected fieldmProcessSiteObjectsHashtable
Hashtable with lists of site objects to be processed.
Protected fieldmSelectedGlobalObjectsHashtable
Hashtable with lists of global selected objects [ObjectType.ToLowerCSafe()] -> [List of code names]
Protected fieldmSelectedGlobalTasksHashtable
Hashtable with lists of global selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs]
Protected fieldmSelectedSiteObjectsHashtable
Hashtable with lists of site selected objects [ObjectType.ToLowerCSafe()] -> [List of code names]
Protected fieldmSelectedSiteTasksHashtable
Hashtable with lists of site selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs]
Protected fieldmSettingsHashtable
Hashtable with additional settings.
Protected fieldmSiteId
Site ID.
Protected fieldmSiteInfo
Site info.
Protected fieldmSiteName
Site name.
Protected fieldmTemporaryFilesPath
Temporary files path.
Protected fieldmUICulture
Current UI culture.
Protected fieldmVersionsComparations
Versions comparations.
Protected fieldmWebsitePath
Website path.
Protected fieldmWriteLog
If true, write to the log is enabled.
Public fieldStatic memberSEPARATOR
Internal status separator.
Top
Properties
  NameDescription
Public propertyAdministratorId
Administrator user ID.
Public propertyCurrentUser
Current user info.
Public propertyDefaultProcessObjectType
Default object process type.
Protected propertyEventLog
Event log object.
Public propertyEventLogCode
Event log code.
Public propertyEventLogSource
Event log source.
Public propertyExcludedNames
Array of expressions. Objects with display names and code names starting with these expresions are filtered out.
Public propertyHotfixVersion
Hotfix version of the package.
Public propertyInfoDataSet
DataSet with additional information.
Public propertyIsInstallableModule
Indicates if export or import is being performed as part of installable module package creation or installation.
Public propertyLogContext
Log context used to log progress
Public propertyModuleName
Specifies code name of the module that is imported or exported as an installable module package.
Public propertyOriginalTemporaryFilesPath
Original temporary files path.
Public propertyPersistentSettingsKey
Key for presistent storage.
Public propertyProcessCanceled
Indicates if the process should be canceled.
Public propertySiteId
Site ID of the site to be processed.
Public propertySiteInfo
Site info of the site to be processed.
Public propertySiteName
Site name of the site to be processed.
Public propertyTemporaryFilesPath
Physical path to the temporary files (ends with \).
Public propertyUICulture
UI culture.
Public propertyVersion
Version of the package.
Public propertyWebsitePath
Physical path to the web site root (ends with \).
Public propertyWriteLog
Indicates if logging to the log is enabled.
Top
Methods
  NameDescription
Public methodCancel
Cancels the process.
Public methodClearProgressLog
Clears progress log.
Public methodDeselect
Selects the given object.
Public methodDeselectTask
Selects the given task.
Public methodGetAPIString
Gets resource string in correct culture.
Public methodStatic memberGetFromPersistentStorage
Gets the settings from the persistent storage.
Public methodGetInfo
Gets additional information.
Public methodGetObjectData
Serialization function.
Public methodGetObjectsProcessType
Gets process type of object type.
Public methodGetObjectTypeFilePath
Gets file path within the package for object type.
Public methodGetObjectWhereCondition
Gets the where condition for specified type of object.
Public methodGetProgressState
Gets progress state.
Public methodGetSelectedObjects
Gets selected objects of specified type.
Public methodGetSelectedObjectsArray
Gets selected objects of specified type.
Public methodGetSelectedObjectTypes
Gets object types that have been selected to process.
Public methodGetSelectedTasks
Gets selected tasks of specified type.
Public methodGetSelectedTasksArray
Gets selected tasks of specified type.
Public methodGetSettings
Gets additional settings.
Public methodIsAutomaticallySelected
Indicates if given object type is automatically selected.
Public methodIsEmptyObjectSelection
Check if there is no selected object in general.
Public methodIsEmptyObjectSelection(Boolean)
Check if there is no selected object.
Public methodIsEmptySelection
Check if there is no selected object or task in general.
Public methodIsEmptyTaskSelection
Check if there is no selected tasks in general.
Public methodIsEmptyTaskSelection(Boolean)
Check if there is no selected tasks.
Public methodIsError
Returns true if there is an error during the process.
Public methodIsLowerVersion
Indicates if current version is lower than given one.
Public methodIsObjectTypeProcessed
Check if the object with specified code name is processed.
Public methodIsProcessed
Check if the object with specified code name is processed.
Public methodIsSelected
Check if the object with specified code name is selected.
Public methodIsTaskSelected
Check if the task with specified code name is selected.
Public methodIsUnsupportedVersion
Indicates whether import package version is supported. Import of unsupported package version may result in error. Unsupported version is a version which is two or more major versions behind the current one.
Public methodIsWarning
Returns true if there are warnings during the process.
Protected methodLogProgressError
Logs error progress state.
Public methodLogProgressState
Logs progress state.
Public methodSavePersistent
Saves the settings object to the persistent storage.
Public methodSavePersistentLog
Saves the log to the persistent storage.
Public methodSelect
Selects the given object.
Public methodSelectTask
Selects the given task.
Public methodSetInfo
Sets additional information.
Public methodSetObjectsProcessType
Sets objects process type of specified type.
Public methodSetSelectedObjects
Sets selected objects of specified type.
Public methodSetSelectedTasks
Sets selected objects of specified object type.
Public methodSetSettings
Sets additional settings.
Top
See Also