Class Document

A Google Docs document.

Inheritance

object

Document

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Docs.v1.Data

Assembly: Google.Apis.Docs.v1.dll

Syntax

public class Document : IDirectResponseSchema

Properties

Body

Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("body")]
public virtual Body Body { get; set; }

Property Value

Type	Description
Body

DocumentId

Output only. The ID of the document.

Declaration

[JsonProperty("documentId")]
public virtual string DocumentId { get; set; }

Property Value

Type	Description
string

DocumentStyle

Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("documentStyle")]
public virtual DocumentStyle DocumentStyle { get; set; }

Property Value

Type	Description
DocumentStyle

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Footers

Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("footers")]
public virtual IDictionary<string, Footer> Footers { get; set; }

Property Value

Type	Description
IDictionary<string, Footer>

Footnotes

Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("footnotes")]
public virtual IDictionary<string, Footnote> Footnotes { get; set; }

Property Value

Type	Description
IDictionary<string, Footnote>

Headers

Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("headers")]
public virtual IDictionary<string, Header> Headers { get; set; }

Property Value

Type	Description
IDictionary<string, Header>

InlineObjects

Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("inlineObjects")]
public virtual IDictionary<string, InlineObject> InlineObjects { get; set; }

Property Value

Type	Description
IDictionary<string, InlineObject>

Lists

Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("lists")]
public virtual IDictionary<string, List> Lists { get; set; }

Property Value

Type	Description
IDictionary<string, List>

NamedRanges

Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("namedRanges")]
public virtual IDictionary<string, NamedRanges> NamedRanges { get; set; }

Property Value

Type	Description
IDictionary<string, NamedRanges>

NamedStyles

Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("namedStyles")]
public virtual NamedStyles NamedStyles { get; set; }

Property Value

Type	Description
NamedStyles

PositionedObjects

Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("positionedObjects")]
public virtual IDictionary<string, PositionedObject> PositionedObjects { get; set; }

Property Value

Type	Description
IDictionary<string, PositionedObject>

RevisionId

Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.

Declaration

[JsonProperty("revisionId")]
public virtual string RevisionId { get; set; }

Property Value

Type	Description
string

SuggestedDocumentStyleChanges

Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("suggestedDocumentStyleChanges")]
public virtual IDictionary<string, SuggestedDocumentStyle> SuggestedDocumentStyleChanges { get; set; }

Property Value

Type	Description
IDictionary<string, SuggestedDocumentStyle>

SuggestedNamedStylesChanges

Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document.

Declaration

[JsonProperty("suggestedNamedStylesChanges")]
public virtual IDictionary<string, SuggestedNamedStyles> SuggestedNamedStylesChanges { get; set; }

Property Value

Type	Description
IDictionary<string, SuggestedNamedStyles>

SuggestionsViewMode

Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.

Declaration

[JsonProperty("suggestionsViewMode")]
public virtual string SuggestionsViewMode { get; set; }

Property Value

Type	Description
string

Tabs

Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.

Declaration

[JsonProperty("tabs")]
public virtual IList<Tab> Tabs { get; set; }

Property Value

Type	Description
IList<Tab>

Title

The title of the document.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema