Class Page (2.2.0)

Version 2.2.0

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

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

Implements

Protobuf.IBufferMessage

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
Int32

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type	Description
Int32

SubpagesFieldNumber

public const int SubpagesFieldNumber = 3

Field number for the "subpages" field.

Field Value
Type	Description
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
Type	Description
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value
Type	Description
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
Type	Description
String

Parser

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

Property Value
Type	Description
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
Type	Description
Protobuf.Collections.RepeatedField<Page>

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
Int32

Clone()

public Page Clone()

Returns
Type	Description
Page

Equals(Page)

public bool Equals(Page other)

Parameter
Name	Description
other	Page

Returns
Type	Description
Boolean

Equals(Object)

public override bool Equals(object other)

Parameter
Name	Description
other	Object

Returns
Type	Description
Boolean

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
Int32

MergeFrom(Page)

public void MergeFrom(Page other)

Parameter
Name	Description
other	Page

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)

Parameter
Name	Description
input	Protobuf.CodedInputStream

ToString()

public override string ToString()

Returns
Type	Description
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)

Parameter
Name	Description
output	Protobuf.CodedOutputStream