Click or drag to resize
SiteExportSettings Class
Class representing export settings.
Inheritance Hierarchy

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

The SiteExportSettings type exposes the following members.

Constructors
  NameDescription
Public methodSiteExportSettings(IUserInfo)
Constructor - Creates export settings.
Public methodSiteExportSettings(SerializationInfo, StreamingContext)
Constructor - Constructor for deserialization.
Top
Fields
  NameDescription
Protected fieldmCurrentUser
Current user info.
(Inherited from AbstractImportExportSettings.)
Protected fieldmDefaultProcessObjectType
Default object process type.
(Inherited from AbstractImportExportSettings.)
Protected fieldmEventLog
Event log object.
(Inherited from AbstractImportExportSettings.)
Protected fieldmEventLogCode
Event log code.
(Inherited from AbstractImportExportSettings.)
Protected fieldmEventLogSource
Event log source.
(Inherited from AbstractImportExportSettings.)
Protected fieldmExcludedNames
Excludes object names.
(Inherited from AbstractImportExportSettings.)
Protected fieldmInfoDataSet
Data set with additional information.
(Inherited from AbstractImportExportSettings.)
Protected fieldmPersistentSettingsKey
Persistent key to store the settings.
(Inherited from AbstractImportExportSettings.)
Protected fieldmProcessCanceled
Flag for process cancelation.
(Inherited from AbstractImportExportSettings.)
Protected fieldmProcessGlobalObjectsHashtable
Hashtable with lists of global objects to be processed.
(Inherited from AbstractImportExportSettings.)
Protected fieldmProcessSiteObjectsHashtable
Hashtable with lists of site objects to be processed.
(Inherited from AbstractImportExportSettings.)
Protected fieldmSelectedGlobalObjectsHashtable
Hashtable with lists of global selected objects [ObjectType.ToLowerCSafe()] -> [List of code names]
(Inherited from AbstractImportExportSettings.)
Protected fieldmSelectedGlobalTasksHashtable
Hashtable with lists of global selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs]
(Inherited from AbstractImportExportSettings.)
Protected fieldmSelectedSiteObjectsHashtable
Hashtable with lists of site selected objects [ObjectType.ToLowerCSafe()] -> [List of code names]
(Inherited from AbstractImportExportSettings.)
Protected fieldmSelectedSiteTasksHashtable
Hashtable with lists of site selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs]
(Inherited from AbstractImportExportSettings.)
Protected fieldmSettingsHashtable
Hashtable with additional settings.
(Inherited from AbstractImportExportSettings.)
Protected fieldmSiteId
Site ID.
(Inherited from AbstractImportExportSettings.)
Protected fieldmSiteInfo
Site info.
(Inherited from AbstractImportExportSettings.)
Protected fieldmSiteName
Site name.
(Inherited from AbstractImportExportSettings.)
Protected fieldmTemporaryFilesPath
Temporary files path.
(Inherited from AbstractImportExportSettings.)
Protected fieldmUICulture
Current UI culture.
(Inherited from AbstractImportExportSettings.)
Protected fieldmVersionsComparations
Versions comparations.
(Inherited from AbstractImportExportSettings.)
Protected fieldmWebsitePath
Website path.
(Inherited from AbstractImportExportSettings.)
Protected fieldmWriteLog
If true, write to the log is enabled.
(Inherited from AbstractImportExportSettings.)
Top
Properties
  NameDescription
Public propertyAdministratorId
Administrator user ID.
(Inherited from AbstractImportExportSettings.)
Public propertyCopyFiles
Indicates if the files should be processed.
Public propertyCreatePackage
Indicates if the ZIP package should be created.
Public propertyCurrentUser
Current user info.
(Inherited from AbstractImportExportSettings.)
Public propertyDefaultProcessObjectType
Default object process type.
(Inherited from AbstractImportExportSettings.)
Protected propertyEventLog
Event log object.
(Inherited from AbstractImportExportSettings.)
Public propertyEventLogCode
Event log code.
(Inherited from AbstractImportExportSettings.)
Public propertyEventLogSource
Event log source.
(Inherited from AbstractImportExportSettings.)
Public propertyExcludedNames
Array of expressions. Objects with display names and code names starting with these expresions are filtered out.
(Inherited from AbstractImportExportSettings.)
Public propertyExportType
Type of the export.
Public propertyHotfixVersion
Hotfix version of the package.
(Overrides AbstractImportExportSettingsHotfixVersion.)
Public propertyInfoDataSet
DataSet with additional information.
(Inherited from AbstractImportExportSettings.)
Public propertyIsInstallableModule
Indicates if export or import is being performed as part of installable module package creation or installation.
(Inherited from AbstractImportExportSettings.)
Public propertyLogContext
Log context used to log progress
(Inherited from AbstractImportExportSettings.)
Public propertyModuleName
Specifies code name of the module that is imported or exported as an installable module package.
(Inherited from AbstractImportExportSettings.)
Public propertyOriginalTemporaryFilesPath
Original temporary files path.
(Inherited from AbstractImportExportSettings.)
Public propertyPersistentSettingsKey
Key for presistent storage.
(Inherited from AbstractImportExportSettings.)
Public propertyProcessCanceled
Indicates if the process should be canceled.
(Inherited from AbstractImportExportSettings.)
Public propertySiteId
Site ID of the site to be processed.
(Inherited from AbstractImportExportSettings.)
Public propertySiteInfo
Site info of the site to be processed.
(Inherited from AbstractImportExportSettings.)
Public propertySiteName
Site name of the site to be processed.
(Inherited from AbstractImportExportSettings.)
Public propertyTargetFileName
Target file name of the export package.
Public propertyTargetFullPath
Gets complete target full path with file name.
Public propertyTargetPath
Target path for the export package.
Public propertyTemporaryFilesPath
Physical path to the temporary files (ends with \).
(Inherited from AbstractImportExportSettings.)
Public propertyTimeStamp
If set, only objects modified after this date are exported.
Public propertyUICulture
UI culture.
(Inherited from AbstractImportExportSettings.)
Public propertyVersion
Version of the package.
(Overrides AbstractImportExportSettingsVersion.)
Public propertyWebsitePath
Physical path to the web site root (ends with \).
(Inherited from AbstractImportExportSettings.)
Public propertyWriteLog
Indicates if logging to the log is enabled.
(Inherited from AbstractImportExportSettings.)
Top
Methods
  NameDescription
Public methodCancel
Cancels the process.
(Inherited from AbstractImportExportSettings.)
Public methodClearProgressLog
Clears progress log.
(Inherited from AbstractImportExportSettings.)
Public methodDeselect
Selects the given object.
(Inherited from AbstractImportExportSettings.)
Public methodDeselectTask
Selects the given task.
(Inherited from AbstractImportExportSettings.)
Public methodEnsureAutomaticSelection
Ensures automatic selection for given object type.
Public methodEnsureSelectedObjectsExport
Ensures that the given object type can include selected objects into the export
Public methodGetAPIString
Gets resource string in correct culture.
(Inherited from AbstractImportExportSettings.)
Public methodGetInfo
Gets additional information.
(Inherited from AbstractImportExportSettings.)
Public methodGetObjectData
Gets data for serialization.
(Overrides AbstractImportExportSettingsGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetObjectsProcessType
Gets process type of object type.
(Inherited from AbstractImportExportSettings.)
Public methodGetObjectTypeFilePath
Gets file path within the package for object type.
(Inherited from AbstractImportExportSettings.)
Public methodGetObjectWhereCondition
Gets the where condition for specified type of object.
(Inherited from AbstractImportExportSettings.)
Public methodGetProgressState
Gets progress state.
(Inherited from AbstractImportExportSettings.)
Public methodGetSelectedObjects
Gets selected objects of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodGetSelectedObjectsArray
Gets selected objects of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodGetSelectedObjectTypes
Gets object types that have been selected to process.
(Inherited from AbstractImportExportSettings.)
Public methodGetSelectedTasks
Gets selected tasks of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodGetSelectedTasksArray
Gets selected tasks of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodGetSettings
Gets additional settings.
(Inherited from AbstractImportExportSettings.)
Public methodGetXML
Returns export settings configuration in XML.
Public methodIsAutomaticallySelected
Indicates if given object type is automatically selected.
(Inherited from AbstractImportExportSettings.)
Public methodIsEmptyObjectSelection
Check if there is no selected object in general.
(Inherited from AbstractImportExportSettings.)
Public methodIsEmptyObjectSelection(Boolean)
Check if there is no selected object.
(Inherited from AbstractImportExportSettings.)
Public methodIsEmptySelection
Check if there is no selected object or task in general.
(Inherited from AbstractImportExportSettings.)
Public methodIsEmptyTaskSelection
Check if there is no selected tasks in general.
(Inherited from AbstractImportExportSettings.)
Public methodIsEmptyTaskSelection(Boolean)
Check if there is no selected tasks.
(Inherited from AbstractImportExportSettings.)
Public methodIsError
Returns true if there is an error during the process.
(Inherited from AbstractImportExportSettings.)
Public methodStatic memberIsExportedObjectType
Returns true if the given object type is exported type (root type).
Public methodIsLowerVersion
Indicates if current version is lower than given one.
(Inherited from AbstractImportExportSettings.)
Public methodIsObjectTypeProcessed
Check if the object with specified code name is processed.
(Inherited from AbstractImportExportSettings.)
Public methodIsProcessed
Check if the object with specified code name is processed.
(Inherited from AbstractImportExportSettings.)
Public methodIsSelected
Check if the object with specified code name is selected.
(Inherited from AbstractImportExportSettings.)
Public methodIsTaskSelected
Check if the task with specified code name is selected.
(Inherited from AbstractImportExportSettings.)
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.
(Inherited from AbstractImportExportSettings.)
Public methodIsWarning
Returns true if there are warnings during the process.
(Inherited from AbstractImportExportSettings.)
Public methodLoadDefaultSelection(Boolean)
Loads the default selection to the export settings tables.
Public methodLoadDefaultSelection(DefaultSelectionParameters)
Loads the default selection to the import settings tables.
Public methodLoadFromXML
Loads export settings configuration from XML.
Protected methodLogProgressError
Logs error progress state.
(Inherited from AbstractImportExportSettings.)
Public methodLogProgressState
Logs progress state.
(Inherited from AbstractImportExportSettings.)
Public methodSavePersistent
Saves the settings object to the persistent storage.
(Inherited from AbstractImportExportSettings.)
Public methodSavePersistentLog
Saves the log to the persistent storage.
(Inherited from AbstractImportExportSettings.)
Public methodSelect
Selects the given object.
(Inherited from AbstractImportExportSettings.)
Public methodSelectGlobalObjects
Selects the exported objects by their name prefixes
Public methodSelectTask
Selects the given task.
(Inherited from AbstractImportExportSettings.)
Public methodSetInfo
Sets additional information.
(Inherited from AbstractImportExportSettings.)
Public methodSetObjectsProcessType
Sets objects process type of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodSetSelectedObjects
Sets selected objects of specified type.
(Inherited from AbstractImportExportSettings.)
Public methodSetSelectedTasks
Sets selected objects of specified object type.
(Inherited from AbstractImportExportSettings.)
Public methodSetSettings
Sets additional settings.
(Inherited from AbstractImportExportSettings.)
Top
See Also