SiteImportSettings Class

Class representing import settings.

Inheritance Hierarchy

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

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

Syntax

[SerializableAttribute]
public class SiteImportSettings : AbstractImportExportSettings

The SiteImportSettings type exposes the following members.

Constructors

	Name	Description
Public method	SiteImportSettings()	Obsolete. Constructor - Creates import settings.
Public method	SiteImportSettings(IUserInfo)	Constructor - Creates import settings.
Public method	SiteImportSettings(SerializationInfo, StreamingContext)	Constructor - Constructor for deserialization.

Methods

	Name	Description
Public method	Cancel	Cancels the process. (Inherited from AbstractImportExportSettings.)
Public method	ClearInfoData	Clears info data
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	FinalizeEventLog	Finalizes event log. (Inherited from AbstractImportExportSettings.)
Public method	GetAPIString	Gets resource string in correct culture. (Inherited from AbstractImportExportSettings.)
Public method	GetInfo	Gets additional information. (Inherited from AbstractImportExportSettings.)
Public method	GetLimitedProgressLog	Gets limited progress log for callback. (Inherited from AbstractImportExportSettings.)
Public method	GetObjectData	Serialization function. (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	HandleObjectTypeClassNotFound	Handles DataClassNotFoundException. Logs warning if missing data class belongs to the object type that is not imported by the currently installed module. Returns the message that was logged or empty string.
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	IsIncluded(String)	Check if object type (site or global) is included in the package.
Public method	IsIncluded(String, Boolean)	Check if object type is included in the package.
Public method	IsLowerVersion(String)	Indicates if current version is lower than given one. (Inherited from AbstractImportExportSettings.)
Public method	IsLowerVersion(String, String)	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	IsWarning	Returns true if there are warnings during the process. (Inherited from AbstractImportExportSettings.)
Public method	LoadDefaultSelection()	Loads the default selection to the export settings tables.
Public method	LoadDefaultSelection(Boolean)	Loads the default selection to the export settings tables.
Public method	LoadDefaultSelection(String, Boolean, ImportTypeEnum)	Loads the default selection to the export settings tables.
Public method	LoadDefaultSelection(String, Boolean, ImportTypeEnum, Boolean, Boolean)	Loads the default selection to the export settings tables.
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	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.)

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. (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	mFileOperations	File operation collection.
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	mProgressLog	Process state. (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	AppCodeFolder	Name of the App_Code folder (depending on the package source - WebApp vs Website)
Public property	CopyCodeFiles	Indicates if the code files should be processed.
Public property	CopyFiles	Indicates if the files should be processed.
Public property	CreateVersion	Indicates if the object version should be created for imported objects.
Public property	CurrentUrl	Current URL of the import process.
Public property	CurrentUser	Current user info. (Inherited from AbstractImportExportSettings.)
Public property	DefaultProcessObjectType	Default object process type. (Inherited from AbstractImportExportSettings.)
Public property	DeleteTemporaryFiles	Indicates if temporary files were created and should be deleted.
Public property	EnableSearchTasks	Indicates if the search tasks should be enabled.
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	ExistingSite	If true, import is into an existing site (defined by SiteId).
Public property	FileOperations	File operations collection.
Public property	FullVersion	Full package version
Public property	HotfixVersion	Hotfix package version (Overrides AbstractImportExportSettings.HotfixVersion.)
Public property	ImportSite	Indicates if site should be imported
Public property	ImportType	Type of the import process.
Public property	InfoDataSet	DataSet with additional information. (Inherited from AbstractImportExportSettings.)
Public property	IsOlderHotfixVersion	Indicates if package is from older version including hotfix.
Public property	IsOlderVersion	Indicates if package is from older version.
Public property	IsQuerySpecialCaseRequired	Indicates whether special handling of query import is required when dealing with this package version.
Public property	IsWebApplication	Indicates whether the packages comes from web application or web site.
Public property	IsWebTemplate	Indicates if web template is imported.
Public property	LogIntegration	Indicates if the integration tasks should be logged.
Public property	LogObjectsWarnings	Indicates if binding and objects warnings should be logged.
Public property	LogSynchronization	Indicates if the synchronization should be logged.
Public property	ModuleName	Specifies code name of the module that is imported by the package.
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	ProgressLog	Progress log of the process. (Inherited from AbstractImportExportSettings.)
Public property	RebuildSearchIndex	Indicates if site search indexes should be rebuilt at the end of import.
Public property	RefreshMacroSecurity	Indicates if the macros security parameters should be refreshed during import.
Public property	ScriptParameter	Parameter which is used for SQL script execution.
Public property	SiteDescription	Site description.
Public property	SiteDisplayName	Site display name.
Public property	SiteDomain	Site domain name.
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	SiteIsIncluded	Indicates if the site should be included in the package.
Public property	SiteName	Site name of the site to be processed. (Inherited from AbstractImportExportSettings.)
Public property	SourceFilePath	Full source file path of the package (ends with \).
Public property	TemporaryFilesCreated	Indicates if temporary files were created.
Public property	TemporaryFilesPath	Physical path to the temporary files (ends with \). (Inherited from AbstractImportExportSettings.)
Public property	TranslationSiteId	Site ID of the site to be used for IDs translation.
Public property	UICulture	UI culture. (Inherited from AbstractImportExportSettings.)
Public property	UseAutomaticSiteForTranslation	Indicates if site name from translation records should be used as a site source for objects.
Public property	UseOldZipProvider	Indicates if old ZIP provider should be used.
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.)