 | Wiki |
This is preliminary documentation and is subject to change.
Inheritance HierarchyNamespace: WikiClientLibrary.Pages
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
SyntaxThe WikiPageStub type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WikiPageStub(Int64) | Initializes a new instance of WikiPageStub. |
| WikiPageStub(String) | Initializes a new instance of WikiPageStub. |
| WikiPageStub(String, Int32) | Initializes a new instance of WikiPageStub. |
| WikiPageStub(Int32, String, Int32) | Obsolete. Initializes a new instance of the WikiPageStub class |
| WikiPageStub(Int64, String, Int32) | Initializes a new instance of WikiPageStub. |
Properties| Name | Description | |
|---|---|---|
 | HasId | Gets a value that indicates whether Id contains page ID information. |
| HasNamespaceId | Gets a value that indicates whether Id contains page namespace ID information. |
| HasTitle | Gets a value that indicates whether Title contains page title information. |
| Id | Gets the page ID. |
| IsEmpty | Checks whether the current structure does not represent an (existent or missing) page. |
| IsInvalid | Checks whether the structure represents a invalid page. |
| IsMissing | Checks whether the page is confirmed as missing. |
| IsSpecial | Checks whether the structure represents a Special page. |
| NamespaceId | Gets the namespace ID of the page. |
| Title | Gets the full title of the page. |
Methods| Name | Description | |
|---|---|---|
| Equals(Object) | Indicates whether this instance and a specified object are equal. (Overrides ValueTypeEquals(Object)) |
| Equals(WikiPageStub) | Indicates whether the current object is equal to another object of the same type. |
 | FromPageIds | Construct a sequence of WikiPageStub from the given page IDs. |
| FromPageTitles | Construct a sequence of WikiPageStub from the given page titles. |
| GetHashCode | Returns the hash code for this instance. (Overrides ValueTypeGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| NewInvalidPage | |
| NewMissingPage(Int64) | |
| NewMissingPage(String, Int32) | |
| NewSpecialPage(String, Int32) | |
| NewSpecialPage(String, Int32, Boolean) | |
| ToString | Returns the fully qualified type name of this instance. (Overrides ValueTypeToString) |
Operators| Name | Description | |
|---|---|---|
 | Equality(WikiPageStub, WikiPageStub) | |
| (Int64 to WikiPageStub) | |
| (NullableInt64 to WikiPageStub) | |
| (String to WikiPageStub) | |
| Inequality(WikiPageStub, WikiPageStub) |
Fields| Name | Description | |
|---|---|---|
 | Empty | An WikiPageStub that represents no page. This is the default value of the structure. |
| InvalidPageIdMask | The Id value used for invalid page. |
| MissingPageIdMask | The Id value used for missing page. |
| MissingPageTitle | The Title value used for missing page. |
| SpecialPageIdMask | The Id value used for Special page. |
| UnknownNamespaceId | The NamespaceId used when the constructor do not have namespace information about the page. |
RemarksDepending on the given information, the structure may contain page ID, page name, or both. If the owner does not know part of the information, these properties can be 0 and null respectively.
This structure can also represent missing (or inexistent) pages. A missing page has either a page ID or a page name, not both. For the missing page with the given page ID, its Title should be MissingPageTitle; for the missing page with the given page title, the Id should be . You can use IsMissing property to check for missing pages.
Since this structure can be implicitly converted from String (page title) and Int32 (page ID), you can use literal page title or page ID in the place where WikiPageStub is needed.
See Also