Send feedback
Class Page (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
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.
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
Page()
Page(Page)
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>(== include {path}
==)</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; }
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: (== include tutorial.md ==)
subpages:
name: Java
content: (== include tutorial_java.md ==)
</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; }
Subpages
public RepeatedField<Page> Subpages { get; }
Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
Methods
CalculateSize()
public int CalculateSize()
Returns
Type
Description
int
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)
ToString()
public override string ToString()
Returns
Type
Description
string
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-10 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-10 UTC."}