An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

MimeType *

The MimeType parameter specifies the MIME type of the format.

Field Name: MimeType
Type: String

IsFormatUserDefined

Field Name: IsFormatUserDefined
Type: Boolean

Name *

The Name specifies a friendly name for the format, but does not need to be unique. For example, you might have several different formats (supported by custom IFilters) that are used to index output from a proprietary system called "My Business Output". You could use the Name parameter to create a category of formats called "My Business Output Formats", and uniquely identify each format within that group using the Identity parameter.

Field Name: Name
Type: String

Extension *

The Extension parameter specifies the file type to be processed by the filter, and is designated by the common file extension associated with the file type. Examples include .MP3, .JPG, and .PNG. Note the leading period.

Field Name: Extension
Type: String

DocumentClass

Field Name: DocumentClass
Type: String

IsBindUserDefined

Field Name: IsBindUserDefined
Type: Boolean

PSComputerName

Field Name: PSComputerName
Type: String

Enabled

The Enabled parameter specifies whether the new format is enabled at creation. Valid input for this parameter is $true or $false. The default is $true.

Field Name: Enabled
Type: Boolean

Server

The Server parameter specifies the Exchange server on which you want to run this command. You can use any value that uniquely identifies the server. For example: Name FQDN Distinguished name (DN) Exchange Legacy DN If you don't use the Server parameter, the command is run on the local server.

Field Name: Server
Type: String

ObjectState

Field Name: ObjectState
Type: String

IsValid

Field Name: IsValid
Type: Boolean

RunspaceId

Field Name: RunspaceId
Type: String

PSShowComputerName

Field Name: PSShowComputerName
Type: Boolean

FormatHandler

Field Name: FormatHandler
Type: String

Identity *

The Identity parameter uniquely identifies the new search document format. For example, an identity of "PropSCT" might specify a proprietary document format which is supported by a custom IFilter. The Identity parameter must be unique within the search document formats.

Field Name: Identity
Type: String

Model: device/exchangehybrid/SearchDocumentFormat

Model Details