Class Page

public sealed class Page : Protobuf.IMessage<Page>, Protobuf.IBufferMessage

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
TypeNameDescription
Pageother

Fields

ContentFieldNumber

public const int ContentFieldNumber = 2

Field number for the "content" field.

Field Value
TypeDescription
Int32

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
TypeDescription
Int32

SubpagesFieldNumber

public const int SubpagesFieldNumber = 3

Field number for the "subpages" field.

Field Value
TypeDescription
Int32

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.

Property Value
TypeDescription
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.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
TypeDescription
String

Parser

public static Protobuf.MessageParser<Page> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<Page>

Subpages

public Protobuf.Collections.RepeatedField<Page> Subpages { get; }

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

Property Value
TypeDescription
Protobuf.Collections.RepeatedField<Page>

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public Page Clone()
Returns
TypeDescription
Page

Equals(Page)

public bool Equals(Page other)
Parameter
TypeNameDescription
Pageother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(Page)

public void MergeFrom(Page other)
Parameter
TypeNameDescription
Pageother

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
TypeNameDescription
Protobuf.CodedInputStreaminput

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
TypeNameDescription
Protobuf.CodedOutputStreamoutput

Implements