Show / Hide Table of Contents

# Class ImportTranslationDocumentOptions

Describes the configuration options of importing a file as a document into a server projects.

##### Inheritance

Object
ImportTranslationDocumentOptions

##### Syntax

    public class ImportTranslationDocumentOptions

### Fields

#### CreatePreview

Enables or disables preview creation during import.

##### Declaration

    public PreviewCreation CreatePreview

##### Type

PreviewCreation

#### ExternalDocumentId

An identifier of this document that is provided by the caller and stored by memoQ. The value is not interpreted, only stored and used for example when signalling delivery through a callback to the external tool.

##### Declaration

    public string ExternalDocumentId

##### Type

String

#### FileGuid

The guid of the file to import. The file have to be uploaded before using IFileManagerService. The guid is returned by IFileManagerService.BeginChunkedFileUpload.

##### Declaration

    public Guid FileGuid

##### Type

Guid

#### FilterConfigResGuid

The guid of the filter configuration resource to be used during the import.

When this member is set, ImportSettingsXML must not be set. If neither this member nor ImportSettingsXML is set, the file will be imported with default configuration matching the file extension.

##### Declaration

    public Guid FilterConfigResGuid

##### Type

Guid

#### ImportEmbeddedImages

Determines whether to import embedded images from the file. The images will appear as translatable documents. Embedded images can be imported from Office Open XML documents (docx, pptx, xlsx).

##### Declaration

    public bool ImportEmbeddedImages

##### Type

Boolean

#### ImportEmbeddedObjects

Determines whether to import embedded objects from the file. Embedded objects are for example an embedded Excel spreadsheet in a Word document. Supported embedded objects will appear as translatable documents. Embedded objects can be imported from Office Open XML documents (docx, pptx, xlsx). If the specified filter configuration does not specify the configuration of embedded objects, they will be imported with default configurations.

##### Declaration

    public bool ImportEmbeddedObjects

##### Type

Boolean

#### ImportSettingsXML

The settings of the import in memoQ import filter XML format.

When this member is set, FilterConfigResGuid must not be set. If neither this member nor FilterConfigResGuid is set, the file will be imported with default configuration matching the file extension.

##### Declaration

    public string ImportSettingsXML

##### Type

String

#### PathToSetAsImportPath

The full path which should be set as the import path of the file. Since the files are uploaded via IFileManagerService, their original location is not retained during import. If this path is specified, this string will be saved as the import path of the document, and will be the bases for calculating the export path.

##### Declaration

    public string PathToSetAsImportPath

##### Type

String

#### TargetLangCodes

The three+(two) letter code of the target languages the document is to be imported into. If null, the document is imported into all target languages of the project. If not null, only target languages that are subset of the target languages of the project can be specified.

##### Declaration

    public string[] TargetLangCodes

##### Type

String[]