# Microsoft.Search.Response.Document Schema Documentation

This topic contains documentation for the Microsoft.Search.Response.Document schema. For the text of the schema, see Microsoft.Search.Response.Document Schema.

## Documentation for the urn:Microsoft.Search.Response.Document schema

Defines a document, which typically consists of a title, description, and link.

## Basic Schema Attributes

Attribute | Value
--- | ---
targetNamespace | urn:Microsoft.Search.Response.Document
elementFormDefault | qualified
attributeFormDefault | unqualified (default)

## Declared Namespaces

Namespace | Prefix
--- | ---
urn:Microsoft.Search.Types | t:
urn:Microsoft.Search.Response.Document | (default)
http://www.w3.org/2001/XMLSchema | xsd:
http://www.w3.org/XML/1998/namespace | xml:

## Imported Schemas

namespace | id | schemaLocation
--- | --- | ---
urn:Microsoft.Search.Types | (none) | Microsoft.Search.Types.xsd

## Overview

<Document>

<Title/>

<Action>

<LinkUrl/>

</Action>

<DisplayUrl/>

<DestinationUrl/>

<Description/>

<Date/>

<Media>

<SrcUrl/>

<LinkUrl/>

<AltText/>

</Media>

<Any/>

</Document>

## Top-Level Elements

Element: Document

Defines a document, which typically consists of a title, description, and link.

Property | Value
--- | ---
abstract | false (default)
name | Document
nillable | false (default)
type | complexType

Attributes

- Attribute: type

  Arbitrary type that defines the type of document. Not currently used by Microsoft® Office 2003.

  Property | Value
  --- | ---
  name | type
  type | t:String255
  use | optional

- Attribute: relevance

  Relevance information, with 1 being the highest. Not currently used by Office 2003.

  Property | Value
  --- | ---
  name | relevance
  type | xsd:double
  use | optional

- Attribute: revision

  Unsigned integer indicating the revision of the schema used in the response.

  Property | Value
  --- | ---
  name | revision
  type | xsd:unsignedInt
  use | optional

- Attribute: build

  The build of the component used to generate the response.

  Property | Value
  --- | ---
  name | build
  type | t:String255
  use | optional

- Attribute: rtl

  If set to true, the document is displayed right-to-left. If set to false, the document is displayed left-to-right. If unspecified, the system will choose.

  Property | Value
  --- | ---
  name | rtl
  type | xsd:boolean
  use | optional

Subelements: Sequence

Elements must appear in the specified order.

- Element: Title

  Title of the document. If not specified, a default will be provided.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | Title
  nillable | false (default)
  type | TitleType

- Element: Action

  The URL to be launched.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | Action
  nillable | false (default)
  type | ActionType

- Element: DisplayUrl

  The friendly name for the link that will display in the results.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | DisplayUrl
  nillable | false (default)
  type | xsd:string

- Element: DestinationUrl

  This is the URL where the user will finally end up after all the possible redirections. Used for removal of duplications.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | DestinationUrl
  nillable | false (default)
  type | xsd:anyURI

- Element: Description

  Document description

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | Description
  nillable | false (default)
  type | DescriptionType

- Element: Date

  This date could have a different connotation depending on the context. It could mean last crawled date, last updated date, or expiration date (for news). It's up to the server and client to decide its usage. Office does not currently use this date.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | 1 (default)
  name | Date
  nillable | false (default)
  type | xsd:dateTime

- Element: Media

  Collection of media elements related to the result. The type attribute defines whether the media is an image, audio, or video link.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 0
  maxOccurs | unbounded
  name | Media
  nillable | false (default)
  type | MediaType

- Any

  Any element in another namespace. Can be used for extensibility in the future.

  Property | Value
  --- | ---
  namespace | ##other
  processContents | skip
  minOccurs | 0
  maxOccurs | unbounded

## Top-Level Types and Groups

- Complex Type: TitleType

  Defines the title of a document.

  Attributes

  - Attribute: rtl

    If set to true, the text is displayed right-to-left. If set to false, the text is displayed left-to-right.

    Property | Value
    --- | ---
    name | rtl
    type | xsd:boolean
    use | optional

  Simple Content

  Base

  base | t:String2048

- Complex Type: ActionType

  Defines the URL to be launched and the requery context to be sent.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: LinkUrl

    The URL that the user goes to initially. The user might be redirected from this URL to another location.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | LinkUrl
    nillable | false (default)
    type | complexType

    Attributes

    - Attribute: fileExt

      The file extension for the file. Used to generate an icon for the file.

      Property | Value
      --- | ---
      name | fileExt
      type | t:String255
      use | optional

    - Attribute: size

      The size of the file in bytes.

      Property | Value
      --- | ---
      name | size
      type | xsd:unsignedInt
      use | optional

    - Attribute: forPay

      If set to true, it indicates that the link takes the user to paid content through a special currency icon.

      Property | Value
      --- | ---
      default | false
      name | forPay
      type | xsd:boolean
      use | optional

    Simple Content

    Base

    base | xsd:anyURI

- Complex Type: DescriptionType

  Defines a document's description.

  Attributes

  - Attribute: rtl

    If set to true, the text is displayed right-to-left. If set to false, the text is displayed left-to-right.

    Property | Value
    --- | ---
    name | rtl
    type | xsd:boolean
    use | optional

  Simple Content

  Base

  base | xsd:string

- Complex Type: MediaType

  A media element related to the result. The type attribute defines whether the media is an image, audio clip, or video clip. Office itself handles only images; other applications handle audio and video clips.

  Attributes

  - Attribute: type

    The type of media. Office can handle only the image type.

    Property | Value
    --- | ---
    name | type
    type | simpleType
    use | required

    Base

    base | xsd:string

    Restrictions

    Restriction | Value
    --- | ---
    enumeration | IMAGE AUDIO VIDEO

  Subelements: Sequence

  Elements must appear in the specified order.

  - Element: SrcUrl

    This is the source of the media clip.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | SrcUrl
    nillable | false (default)
    type | xsd:anyURI

  - Element: LinkUrl

    This is the URL associated with images. Office does not currently support this element.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 1 (default)
    name | LinkUrl
    nillable | false (default)
    type | xsd:anyURI

  - Element: AltText

    Alternative text associated with the image. Used by accessibility tools.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 1 (default)
    name | AltText
    nillable | false (default)
    type | t:String255

©2003-2004 Microsoft Corporation. All rights reserved. Permission to copy, display and distribute this document is available at: http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp