SiteExportSettings Class

Class representing export settings.

Inheritance Hierarchy

System.Object
  CMS.CMSImportExport.AbstractImportExportSettings
    CMS.CMSImportExport.SiteExportSettings

Namespace: CMS.CMSImportExport
Assembly: CMS.ImportExport (in CMS.ImportExport.dll) Version: 13.0.131

Syntax

[SerializableAttribute]
public class SiteExportSettings : AbstractImportExportSettings

The SiteExportSettings type exposes the following members.

Constructors

	Name	Description
Public method	SiteExportSettings(IUserInfo)	Constructor - Creates export settings.
Public method	SiteExportSettings(SerializationInfo, StreamingContext)	Constructor - Constructor for deserialization.

Fields

	Name	Description
Protected field	mCurrentUser	Current user info. (Inherited from AbstractImportExportSettings.)
Protected field	mDefaultProcessObjectType	Default object process type. (Inherited from AbstractImportExportSettings.)
Protected field	mEventLog	Event log object. (Inherited from AbstractImportExportSettings.)
Protected field	mEventLogCode	Event log code. (Inherited from AbstractImportExportSettings.)
Protected field	mEventLogSource	Event log source. (Inherited from AbstractImportExportSettings.)
Protected field	mExcludedNames	Excludes object names. (Inherited from AbstractImportExportSettings.)
Protected field	mInfoDataSet	Data set with additional information. (Inherited from AbstractImportExportSettings.)
Protected field	mPersistentSettingsKey	Persistent key to store the settings. (Inherited from AbstractImportExportSettings.)
Protected field	mProcessCanceled	Flag for process cancelation. (Inherited from AbstractImportExportSettings.)
Protected field	mProcessGlobalObjectsHashtable	Hashtable with lists of global objects to be processed. (Inherited from AbstractImportExportSettings.)
Protected field	mProcessSiteObjectsHashtable	Hashtable with lists of site objects to be processed. (Inherited from AbstractImportExportSettings.)
Protected field	mSelectedGlobalObjectsHashtable	Hashtable with lists of global selected objects [ObjectType.ToLowerCSafe()] -> [List of code names] (Inherited from AbstractImportExportSettings.)
Protected field	mSelectedGlobalTasksHashtable	Hashtable with lists of global selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs] (Inherited from AbstractImportExportSettings.)
Protected field	mSelectedSiteObjectsHashtable	Hashtable with lists of site selected objects [ObjectType.ToLowerCSafe()] -> [List of code names] (Inherited from AbstractImportExportSettings.)
Protected field	mSelectedSiteTasksHashtable	Hashtable with lists of site selected tasks [ObjectType.ToLowerCSafe()] -> [List of task IDs] (Inherited from AbstractImportExportSettings.)
Protected field	mSettingsHashtable	Hashtable with additional settings. (Inherited from AbstractImportExportSettings.)
Protected field	mSiteId	Site ID. (Inherited from AbstractImportExportSettings.)
Protected field	mSiteInfo	Site info. (Inherited from AbstractImportExportSettings.)
Protected field	mSiteName	Site name. (Inherited from AbstractImportExportSettings.)
Protected field	mTemporaryFilesPath	Temporary files path. (Inherited from AbstractImportExportSettings.)
Protected field	mUICulture	Current UI culture. (Inherited from AbstractImportExportSettings.)
Protected field	mVersionsComparations	Versions comparations. (Inherited from AbstractImportExportSettings.)
Protected field	mWebsitePath	Website path. (Inherited from AbstractImportExportSettings.)
Protected field	mWriteLog	If true, write to the log is enabled. (Inherited from AbstractImportExportSettings.)

Properties

	Name	Description
Public property	AdministratorId	Administrator user ID. (Inherited from AbstractImportExportSettings.)
Public property	CopyFiles	Indicates if the files should be processed.
Public property	CreatePackage	Indicates if the ZIP package should be created.
Public property	CurrentUser	Current user info. (Inherited from AbstractImportExportSettings.)
Public property	DefaultProcessObjectType	Default object process type. (Inherited from AbstractImportExportSettings.)
Protected property	EventLog	Event log object. (Inherited from AbstractImportExportSettings.)
Public property	EventLogCode	Event log code. (Inherited from AbstractImportExportSettings.)
Public property	EventLogSource	Event log source. (Inherited from AbstractImportExportSettings.)
Public property	ExcludedNames	Array of expressions. Objects with display names and code names starting with these expresions are filtered out. (Inherited from AbstractImportExportSettings.)
Public property	ExportType	Type of the export.
Public property	HotfixVersion	Hotfix version of the package. (Overrides AbstractImportExportSettings.HotfixVersion.)
Public property	InfoDataSet	DataSet with additional information. (Inherited from AbstractImportExportSettings.)
Public property	IsInstallableModule	Indicates if export or import is being performed as part of installable module package creation or installation. (Inherited from AbstractImportExportSettings.)
Public property	LogContext	Log context used to log progress (Inherited from AbstractImportExportSettings.)
Public property	ModuleName	Specifies code name of the module that is imported or exported as an installable module package. (Inherited from AbstractImportExportSettings.)
Public property	OriginalTemporaryFilesPath	Original temporary files path. (Inherited from AbstractImportExportSettings.)
Public property	PersistentSettingsKey	Key for presistent storage. (Inherited from AbstractImportExportSettings.)
Public property	ProcessCanceled	Indicates if the process should be canceled. (Inherited from AbstractImportExportSettings.)
Public property	SiteId	Site ID of the site to be processed. (Inherited from AbstractImportExportSettings.)
Public property	SiteInfo	Site info of the site to be processed. (Inherited from AbstractImportExportSettings.)
Public property	SiteName	Site name of the site to be processed. (Inherited from AbstractImportExportSettings.)
Public property	TargetFileName	Target file name of the export package.
Public property	TargetFullPath	Gets complete target full path with file name.
Public property	TargetPath	Target path for the export package.
Public property	TemporaryFilesPath	Physical path to the temporary files (ends with \). (Inherited from AbstractImportExportSettings.)
Public property	TimeStamp	If set, only objects modified after this date are exported.
Public property	UICulture	UI culture. (Inherited from AbstractImportExportSettings.)
Public property	Version	Version of the package. (Overrides AbstractImportExportSettings.Version.)
Public property	WebsitePath	Physical path to the web site root (ends with \). (Inherited from AbstractImportExportSettings.)
Public property	WriteLog	Indicates if logging to the log is enabled. (Inherited from AbstractImportExportSettings.)

Methods

	Name	Description
Public method	Cancel	Cancels the process. (Inherited from AbstractImportExportSettings.)
Public method	ClearProgressLog	Clears progress log. (Inherited from AbstractImportExportSettings.)
Public method	Deselect	Selects the given object. (Inherited from AbstractImportExportSettings.)
Public method	DeselectTask	Selects the given task. (Inherited from AbstractImportExportSettings.)
Public method	EnsureAutomaticSelection	Ensures automatic selection for given object type.
Public method	EnsureSelectedObjectsExport	Ensures that the given object type can include selected objects into the export
Public method	GetAPIString	Gets resource string in correct culture. (Inherited from AbstractImportExportSettings.)
Public method	GetInfo	Gets additional information. (Inherited from AbstractImportExportSettings.)
Public method	GetObjectData	Gets data for serialization. (Overrides AbstractImportExportSettings.GetObjectData(SerializationInfo, StreamingContext).)
Public method	GetObjectsProcessType	Gets process type of object type. (Inherited from AbstractImportExportSettings.)
Public method	GetObjectTypeFilePath	Gets file path within the package for object type. (Inherited from AbstractImportExportSettings.)
Public method	GetObjectWhereCondition	Gets the where condition for specified type of object. (Inherited from AbstractImportExportSettings.)
Public method	GetProgressState	Gets progress state. (Inherited from AbstractImportExportSettings.)
Public method	GetSelectedObjects	Gets selected objects of specified type. (Inherited from AbstractImportExportSettings.)
Public method	GetSelectedObjectsArray	Gets selected objects of specified type. (Inherited from AbstractImportExportSettings.)
Public method	GetSelectedObjectTypes	Gets object types that have been selected to process. (Inherited from AbstractImportExportSettings.)
Public method	GetSelectedTasks	Gets selected tasks of specified type. (Inherited from AbstractImportExportSettings.)
Public method	GetSelectedTasksArray	Gets selected tasks of specified type. (Inherited from AbstractImportExportSettings.)
Public method	GetSettings	Gets additional settings. (Inherited from AbstractImportExportSettings.)
Public method	GetXML	Returns export settings configuration in XML.
Public method	IsAutomaticallySelected	Indicates if given object type is automatically selected. (Inherited from AbstractImportExportSettings.)
Public method	IsEmptyObjectSelection()	Check if there is no selected object in general. (Inherited from AbstractImportExportSettings.)
Public method	IsEmptyObjectSelection(Boolean)	Check if there is no selected object. (Inherited from AbstractImportExportSettings.)
Public method	IsEmptySelection	Check if there is no selected object or task in general. (Inherited from AbstractImportExportSettings.)
Public method	IsEmptyTaskSelection()	Check if there is no selected tasks in general. (Inherited from AbstractImportExportSettings.)
Public method	IsEmptyTaskSelection(Boolean)	Check if there is no selected tasks. (Inherited from AbstractImportExportSettings.)
Public method	IsError	Returns true if there is an error during the process. (Inherited from AbstractImportExportSettings.)
Public method Static member	IsExportedObjectType	Returns true if the given object type is exported type (root type).
Public method	IsLowerVersion	Indicates if current version is lower than given one. (Inherited from AbstractImportExportSettings.)
Public method	IsObjectTypeProcessed	Check if the object with specified code name is processed. (Inherited from AbstractImportExportSettings.)
Public method	IsProcessed	Check if the object with specified code name is processed. (Inherited from AbstractImportExportSettings.)
Public method	IsSelected	Check if the object with specified code name is selected. (Inherited from AbstractImportExportSettings.)
Public method	IsTaskSelected	Check if the task with specified code name is selected. (Inherited from AbstractImportExportSettings.)
Public method	IsUnsupportedVersion	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 method	IsWarning	Returns true if there are warnings during the process. (Inherited from AbstractImportExportSettings.)
Public method	LoadDefaultSelection(Boolean)	Loads the default selection to the export settings tables.
Public method	LoadDefaultSelection(DefaultSelectionParameters)	Loads the default selection to the import settings tables.
Public method	LoadFromXML	Loads export settings configuration from XML.
Protected method	LogProgressError	Logs error progress state. (Inherited from AbstractImportExportSettings.)
Public method	LogProgressState	Logs progress state. (Inherited from AbstractImportExportSettings.)
Public method	SavePersistent	Saves the settings object to the persistent storage. (Inherited from AbstractImportExportSettings.)
Public method	SavePersistentLog	Saves the log to the persistent storage. (Inherited from AbstractImportExportSettings.)
Public method	Select	Selects the given object. (Inherited from AbstractImportExportSettings.)
Public method	SelectGlobalObjects	Selects the exported objects by their name prefixes
Public method	SelectTask	Selects the given task. (Inherited from AbstractImportExportSettings.)
Public method	SetInfo	Sets additional information. (Inherited from AbstractImportExportSettings.)
Public method	SetObjectsProcessType	Sets objects process type of specified type. (Inherited from AbstractImportExportSettings.)
Public method	SetSelectedObjects	Sets selected objects of specified type. (Inherited from AbstractImportExportSettings.)
Public method	SetSelectedTasks	Sets selected objects of specified object type. (Inherited from AbstractImportExportSettings.)
Public method	SetSettings	Sets additional settings. (Inherited from AbstractImportExportSettings.)