Class Page (2.10.0) 

public sealed class Page : IMessage<Page>, IEquatable<Page>, IDeepCloneable<Page>, IBufferMessage, IMessage

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Inheritance

object > Page

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Page()

public Page()

Page(Page)

public Page(Page other)
Parameter
Name Description
other Page

Fields

ContentFieldNumber

public const int ContentFieldNumber = 2

Field number for the "content" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

SubpagesFieldNumber

public const int SubpagesFieldNumber = 3

Field number for the "subpages" field.

Field Value
Type Description
int

Properties

Content

public string Content { get; set; }

The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Property Value
Type Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Name

public string Name { get; set; }

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: <pre><code>pages:

  • name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].
Property Value
Type Description
string

Parser

public static MessageParser<Page> Parser { get; }
Property Value
Type Description
MessageParserPage

Subpages

public RepeatedField<Page> Subpages { get; }

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Property Value
Type Description
RepeatedFieldPage

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public Page Clone()
Returns
Type Description
Page

Equals(Page)

public bool Equals(Page other)
Parameter
Name Description
other Page
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(Page)

public void MergeFrom(Page other)
Parameter
Name Description
other Page

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream