AbstractImportExportSettings Class

Abstract class for import and export settings.

Inheritance Hierarchy

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

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

Syntax

[SerializableAttribute]
public class AbstractImportExportSettings : ISerializable

The AbstractImportExportSettings type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractImportExportSettings(IUserInfo)	Constructor - Creates abstract settings.
Public method	AbstractImportExportSettings(SerializationInfo, StreamingContext)	Constructor - Constructor for deserialization.

Methods

	Name	Description
Public method	Cancel	Cancels the process.
Public method	ClearProgressLog	Clears progress log.
Public method	Deselect	Selects the given object.
Public method	DeselectTask	Selects the given task.
Public method	FinalizeEventLog	Finalizes event log.
Public method	GetAPIString	Gets resource string in correct culture.
Public method Static member	GetFromPersistentStorage	Gets the settings from the persistent storage.
Public method	GetInfo	Gets additional information.
Public method	GetLimitedProgressLog	Gets limited progress log for callback.
Public method	GetObjectData	Serialization function.
Public method	GetObjectsProcessType	Gets process type of object type.
Public method	GetObjectTypeFilePath	Gets file path within the package for object type.
Public method	GetObjectWhereCondition	Gets the where condition for specified type of object.
Public method	GetProgressState	Gets progress state.
Public method	GetSelectedObjects	Gets selected objects of specified type.
Public method	GetSelectedObjectsArray	Gets selected objects of specified type.
Public method	GetSelectedObjectTypes	Gets object types that have been selected to process.
Public method	GetSelectedTasks	Gets selected tasks of specified type.
Public method	GetSelectedTasksArray	Gets selected tasks of specified type.
Public method	GetSettings	Gets additional settings.
Public method	IsAutomaticallySelected	Indicates if given object type is automatically selected.
Public method	IsEmptyObjectSelection()	Check if there is no selected object in general.
Public method	IsEmptyObjectSelection(Boolean)	Check if there is no selected object.
Public method	IsEmptySelection	Check if there is no selected object or task in general.
Public method	IsEmptyTaskSelection()	Check if there is no selected tasks in general.
Public method	IsEmptyTaskSelection(Boolean)	Check if there is no selected tasks.
Public method	IsError	Returns true if there is an error during the process.
Public method	IsLowerVersion(String)	Indicates if current version is lower than given one.
Public method	IsLowerVersion(String, String)	Indicates if current version is lower than given one.
Public method	IsObjectTypeProcessed	Check if the object with specified code name is processed.
Public method	IsProcessed	Check if the object with specified code name is processed.
Public method	IsSelected	Check if the object with specified code name is selected.
Public method	IsTaskSelected	Check if the task with specified code name is selected.
Public method	IsWarning	Returns true if there are warnings during the process.
Protected method	LogProgressError	Logs error progress state.
Public method	LogProgressState	Logs progress state.
Public method	SavePersistent	Saves the settings object to the persistent storage.
Public method	SavePersistentLog	Saves the log to the persistent storage.
Public method	Select	Selects the given object.
Public method	SelectTask	Selects the given task.
Public method	SetInfo	Sets additional information.
Public method	SetObjectsProcessType	Sets objects process type of specified type.
Public method	SetSelectedObjects	Sets selected objects of specified type.
Public method	SetSelectedTasks	Sets selected objects of specified object type.
Public method	SetSettings	Sets additional settings.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

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

Properties

	Name	Description
Public property	AdministratorId	Administrator user ID.
Public property	CurrentUser	Current user info.
Public property	DefaultProcessObjectType	Default object process type.
Protected property	EventLog	Event log object.
Public property	EventLogCode	Event log code.
Public property	EventLogSource	Event log source.
Public property	ExcludedNames	Array of expressions. Objects with display names and code names starting with these expresions are filtered out.
Public property	HotfixVersion	Hotfix version of the package.
Public property	InfoDataSet	DataSet with additional information.
Public property	OriginalTemporaryFilesPath	Original temporary files path.
Public property	PersistentSettingsKey	Key for presistent storage.
Public property	ProcessCanceled	Indicates if the process should be canceled.
Public property	ProgressLog	Progress log of the process.
Public property	SiteId	Site ID of the site to be processed.
Public property	SiteInfo	Site info of the site to be processed.
Public property	SiteName	Site name of the site to be processed.
Public property	TemporaryFilesPath	Physical path to the temporary files (ends with \).
Public property	UICulture	UI culture.
Public property	Version	Version of the package.
Public property	WebsitePath	Physical path to the web site root (ends with \).
Public property	WriteLog	Indicates if logging to the log is enabled.