Click or drag to resize
SiteImportSettings Class
Class representing import settings.
Inheritance Hierarchy

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

The SiteImportSettings type exposes the following members.

Constructors
  NameDescription
Public methodSiteImportSettings(IUserInfo)
Constructor - Creates import settings.
Public methodSiteImportSettings(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 fieldmFileOperations
File operation collection.
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 propertyAllowBulkInsert
If true, the import process allows bulk inserts for the data to speed up the import process. If bulk insert is allowed, some event handlers may not be fired during the import process.
Public propertyAppCodeFolder
Name of the App_Code folder (depending on the package source - WebApp vs Website)
Public propertyCopyCodeFiles
Indicates if the code files should be processed.
Public propertyCopyFiles
Indicates if the files should be processed.
Public propertyCreateVersion
Indicates if the object version should be created for imported objects.
Public propertyCurrentUrl
Current URL of the import process.
Public propertyCurrentUser
Current user info.
(Inherited from AbstractImportExportSettings.)
Public propertyDefaultProcessObjectType
Default object process type.
(Inherited from AbstractImportExportSettings.)
Public propertyDeleteTemporaryFiles
Indicates if temporary files were created and should be deleted.
Public propertyEnableSearchTasks
Indicates if the search tasks should be enabled.
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 propertyExistingSite
If true, import is into an existing site (defined by SiteId).
Public propertyFileOperations
File operations collection.
Public propertyFullVersion
Full package version
Public propertyHotfixVersion
Hotfix package version
(Overrides AbstractImportExportSettingsHotfixVersion.)
Public propertyImportOnlyNewObjects
If true, only new objects (including new children and bindings) are imported and already existing objects are not updated with the package data. This setting is useful especially when importing data from web template which may contain additional child objects but should not overwrite already customized data.
Public propertyImportSite
Indicates if site should be imported
Public propertyImportType
Type of the import process.
Public propertyInfoDataSet
DataSet with additional information.
(Inherited from AbstractImportExportSettings.)
Public propertyIsOlderHotfixVersion
Indicates if package is from older version including hotfix.
Public propertyIsOlderVersion
Indicates if package is from older version.
Public propertyIsWebApplication
Indicates whether the packages comes from web application or web site.
Public propertyIsWebTemplate
Indicates if web template is imported.
Public propertyLogContext
Log context used to log progress
(Inherited from AbstractImportExportSettings.)
Public propertyLogIntegration
Indicates if the integration tasks should be logged.
Public propertyLogObjectsWarnings
Indicates if binding and objects warnings should be logged.
Public propertyLogSynchronization
Indicates if the synchronization should be logged.
Public propertyModuleName
Specifies code name of the module that is imported by the package.
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 propertyRebuildSearchIndex
Indicates if site search indexes should be rebuilt at the end of import.
Public propertyRefreshMacroSecurity
Indicates if the macros security parameters should be refreshed during import.
Public propertyScriptParameter
Parameter which is used for SQL script execution.
Public propertySiteDescription
Site description.
Public propertySiteDisplayName
Site display name.
Public propertySiteDomain
Site domain name.
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 propertySiteIsContentOnly
Content only site
Public propertySiteIsIncluded
Indicates if the site should be included in the package.
Public propertySiteName
Site name of the site to be processed.
(Inherited from AbstractImportExportSettings.)
Public propertySourceFilePath
Full source file path of the package (ends with \).
Public propertyTemporaryFilesCreated
Indicates if temporary files were created.
Public propertyTemporaryFilesPath
Physical path to the temporary files (ends with \).
(Inherited from AbstractImportExportSettings.)
Public propertyTranslationSiteId
Site ID of the site to be used for IDs translation.
Public propertyUICulture
UI culture.
(Inherited from AbstractImportExportSettings.)
Public propertyUseAutomaticSiteForTranslation
Indicates if site name from translation records should be used as a site source for objects.
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 methodClearInfoData
Clears info data
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 methodGetAPIString
Gets resource string in correct culture.
(Inherited from AbstractImportExportSettings.)
Public methodGetInfo
Gets additional information.
(Inherited from AbstractImportExportSettings.)
Public methodGetObjectData
Serialization function.
(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 methodHandleObjectTypeClassNotFound
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 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 methodIsIncluded(String)
Check if object type (site or global) is included in the package.
Public methodIsIncluded(String, Boolean)
Check if object type is included in the package.
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 methodIsWarning
Returns true if there are warnings during the process.
(Inherited from AbstractImportExportSettings.)
Public methodLoadDefaultSelection
Loads the default selection to the export settings tables.
Public methodLoadDefaultSelection(Boolean)
Loads the default selection to the export settings tables.
Public methodLoadDefaultSelection(DefaultSelectionParameters)
Loads the default selection to the import settings tables.
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 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