Class Page

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

Inheritance
System.Object
Page
Implements
System.IEquatable<Page>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class Page : IMessage<Page>, IMessage, IEquatable<Page>, IDeepCloneable<Page>

Constructors

Page()

Declaration
public Page()

Page(Page)

Declaration
public Page(Page other)
Parameters
Type Name Description
Page other

Fields

ContentFieldNumber

Field number for the "content" field.

Declaration
public const int ContentFieldNumber = 2
Field Value
Type Description
System.Int32

NameFieldNumber

Field number for the "name" field.

Declaration
public const int NameFieldNumber = 1
Field Value
Type Description
System.Int32

SubpagesFieldNumber

Field number for the "subpages" field.

Declaration
public const int SubpagesFieldNumber = 3
Field Value
Type Description
System.Int32

Properties

Content

The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file.

Declaration
public string Content { get; set; }
Property Value
Type Description
System.String

Descriptor

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

Name

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].
Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Parser

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

Subpages

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

Declaration
public RepeatedField<Page> Subpages { get; }
Property Value
Type Description
RepeatedField<Page>

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public Page Clone()
Returns
Type Description
Page
Implements

Equals(Page)

Declaration
public bool Equals(Page other)
Parameters
Type Name Description
Page other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(Page)

Declaration
public void MergeFrom(Page other)
Parameters
Type Name Description
Page other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements