Microsoft.Search.Query.Office.Context Schema Documentation

This topic contains documentation for the Microsoft.Search.Query.Office.Context schema. For the text of the schema, see Microsoft.Search.Query.Office.Context Schema.

Documentation for the urn:Microsoft.Search.Query.Office.Context schema

Defines context information that augments a query. The root element in this schema is designed to be used inside the Microsoft.Search.Query.xsd schema.

Basic Schema Attributes

Declared Namespaces

Imported Schemas

Overview

<OfficeContext>

       <UserPreferences>

             <ParentalControl/>

             <Any/>

      </UserPreferences>

       <ServiceData>

             <Data/>

             <Any/>

      </ServiceData>

       <ApplicationContext>

             <Name/>

             <Version/>

             <SystemInformation>

                   <SkuLanguage/>

                   <LanguagePack/>

                   <InterfaceLanguage/>

                   <Location/>

                   <Any/>

            </SystemInformation>

             <Any/>

      </ApplicationContext>

       <QueryLanguage/>

       <KeyboardLanguage/>

       <Any/>

</OfficeContext>

Top-Level Elements

Element: OfficeContext

Context information that may be useful in better handling the query. Describes context information generated by Microsoft® Office 2003.

Attributes

• Attribute: revision

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

  Property	Value
  name	revision
  type	xsd:unsignedInt
  use	optional

• Attribute: build

  The build of the component used to generate the request.

  Property	Value
  name	build
  type	t:String255
  use	optional

Subelements: Sequence

Elements must appear in the specified order.

• Element: UserPreferences

  User information and preferences.

  Property	Value
  abstract	false (default)
  minOccurs	0
  maxOccurs	1 (default)
  name	UserPreferences
  nillable	false (default)
  type	UserPreferencesType

• Element: ServiceData

  Data that the service has stored with Office.

  Property	Value
  abstract	false (default)
  minOccurs	0
  maxOccurs	1 (default)
  name	ServiceData
  nillable	false (default)
  type	ServiceDataType

• Element: ApplicationContext

  The name and version of the application the user is in.

  Property	Value
  abstract	false (default)
  minOccurs	0
  maxOccurs	1 (default)
  name	ApplicationContext
  nillable	false (default)
  type	ApplicationType

• Element: QueryLanguage

  The language that the query is in, if the application recognizes it.

  Property	Value
  abstract	false (default)
  minOccurs	0
  maxOccurs	1 (default)
  name	QueryLanguage
  nillable	false (default)
  type	xsd:language

• Element: KeyboardLanguage

  Language corresponding to the keyboard.

  Property	Value
  abstract	false (default)
  minOccurs	0
  maxOccurs	1 (default)
  name	KeyboardLanguage
  nillable	false (default)
  type	xsd:language

• 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: UserPreferencesType

  Describes user information and preferences.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  • Element: ParentalControl

    Set to true if the user requests filtered content.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	1 (default)
    name	ParentalControl
    nillable	false (default)
    type	xsd:boolean

  • Any

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

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

• Complex Type: ServiceDataType

  Describes service-specific data stored with Office 2003.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  • Element: Data

    Data.

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

  • Any

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

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

• Complex Type: ApplicationType

  Describes data about the application that the user is running.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  • Element: Name

    Application name.

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

  • Element: Version

    Application version.

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

  • Element: SystemInformation

    Information about the system that is sending the query. The service provider can use this to determine how to respond.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	1 (default)
    name	SystemInformation
    nillable	false (default)
    type	SystemInformationType

  • Any

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

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

• Complex Type: SystemInformationType

  Describes information about the system that is requesting the information. The service provider can use this to determine how to respond.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  • Element: SkuLanguage

    The system's main language.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	1 (default)
    name	SkuLanguage
    nillable	false (default)
    type	xsd:language

  • Element: LanguagePack

    One of the system's language flavors. There could be multiple ones.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	unbounded
    name	LanguagePack
    nillable	false (default)
    type	xsd:language

  • Element: InterfaceLanguage

    The current language of the user interface.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	1 (default)
    name	InterfaceLanguage
    nillable	false (default)
    type	xsd:language

  • Element: Location

    The country or region indicating the current location of the system.

    Property	Value
    abstract	false (default)
    minOccurs	0
    maxOccurs	1 (default)
    name	Location
    nillable	false (default)
    type	t:ISO3166Type

  • Any

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

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