Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class DocumentProperties

Class which exposes the document level properties for a Microsoft Excel file.

The properties exposed by this class can be changed on a Microsoft Excel file by right-clicking it in Windows Explorer and editing the properties on the Summary tab.

Hierarchy

Hierarchy

  • Base
    • DocumentProperties

Implements

  • IChangeInfoContext

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

author

  • get author(): string

  • Gets or sets the author of the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the author of the document.

    Returns string

  • set author(a): void

  • Parameters

    • a: string

    Returns void

category

  • get category(): string

  • Gets or sets the category of the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the category of the document.

    Returns string

  • set category(a): void

  • Parameters

    • a: string

    Returns void

comments

  • get comments(): string

  • Gets or sets the comments associated with the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the comments associated with the document.

    Returns string

  • set comments(a): void

  • Parameters

    • a: string

    Returns void

company

  • get company(): string

  • Gets or sets the company to which the document belongs.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the company to which the document belongs.

    Returns string

  • set company(a): void

  • Parameters

    • a: string

    Returns void

keywords

  • get keywords(): string

  • Gets or sets the keywords which describe the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the keywords which describe the document.

    Returns string

  • set keywords(a): void

  • Parameters

    • a: string

    Returns void

manager

  • get manager(): string

  • Gets or sets the manager associated with the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the manager associated with the document.

    Returns string

  • set manager(a): void

  • Parameters

    • a: string

    Returns void

status

  • get status(): string

  • Gets or sets the current status of the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string representing the current status of the document.

    Returns string

  • set status(a): void

  • Parameters

    • a: string

    Returns void

subject

  • get subject(): string

  • Gets or sets the subject of the contents of the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the subject of the contents of the document.

    Returns string

  • set subject(a): void

  • Parameters

    • a: string

    Returns void

title

  • get title(): string

  • Gets or sets the title of the document.

    The value of the property has no effect on the contents of the file when opened in a host application. It is simply extra data associated with the document.

    A string specifying the title of the document.

    Returns string

  • set title(a): void

  • Parameters

    • a: string

    Returns void

Methods

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean