shu/OnDoc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update 20240812

Browse Source
This commit is contained in:
Stefan Hutter
2024-08-12 16:35:06 +02:00
parent 43c44e0aad
commit fc8811829d
7922 changed files with 205978 additions and 91947 deletions
Download Patch File Download Diff File Expand all files Collapse all files

569
VSdoc/topic_00000000000003AB.html
View File

@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="GENERATOR" content="VSdocman - documentation generator; https://www.helixoft.com" />
<link rel="icon" href="favicon.ico">
<title>HelpPageSampleKey.Equals Method</title>
<title>HelpPageSampleGenerator Class</title>
<link rel="stylesheet" type="text/css" href="msdn2019/toc.css" />
<script src="msdn2019/toc.js"></script>
@@ -74,11 +74,11 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div id="mainBody">
<h1 class="title">HelpPageSampleKey.Equals Method</h1>
<h1 class="title">HelpPageSampleGenerator Class</h1>
<div class="metadata">
Namespace:
<a href="topic_000000000000033B.html">API_NetFramework.Areas.HelpPage</a>
<a href="topic_0000000000000354.html">API_NetFramework.Areas.HelpPage</a>
@@ -89,6 +89,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<summary-info>This class will generate the samples for the help page.</summary-info>
@@ -138,7 +139,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeVB">
<pre xml:space="preserve" class="brush: vb">Public Overrides Function Equals( _&nbsp;<br /> ByVal <i>obj</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a> _&nbsp;<br />) As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">Boolean</a></pre>
<pre xml:space="preserve" class="brush: vb">Public Class HelpPageSampleGenerator</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -177,7 +178,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCsharp">
<pre xml:space="preserve" class="brush: csharp">public override <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a> Equals(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a> <i>obj</i>&nbsp;<br />)</pre>
<pre xml:space="preserve" class="brush: csharp">public class HelpPageSampleGenerator</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -217,7 +218,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCpp">
<pre xml:space="preserve" class="brush: cpp">public: &nbsp;<br /><a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a> Equals(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>^ <i>obj</i>&nbsp;<br />) </pre>
<pre xml:space="preserve" class="brush: cpp">public ref class HelpPageSampleGenerator </pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -256,7 +257,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeJScript">
<pre xml:space="preserve" class="brush: js">public function Equals(&nbsp;<br /> <i>obj</i> : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>&nbsp;<br />) : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">boolean</a>;</pre>
<pre xml:space="preserve" class="brush: js">public class HelpPageSampleGenerator</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -267,27 +268,6 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<h4 class="subHeading">
Parameters</h4><dl paramName="obj" class="parameterList">
<dt>
<span class="parameter">
obj
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>
</dd>
</dl>
<p>
</p>
<p />
<h4 class="subHeading">
Return Value</h4>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.boolean">bool</a>
@@ -307,6 +287,530 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Constructors</a></span>
<div>&nbsp;</div>
</div>
<div id="ConstructorsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Public constructor" title="Public constructor" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003AC.html">HelpPageSampleGenerator()</a>
</td>
<td>
Initializes a new instance of the <a target="_top" href="topic_00000000000003AB.html" onclick="this.target='';return true;">HelpPageSampleGenerator</a> class.
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Properties</a></span>
<div>&nbsp;</div>
</div>
<div id="PropertiesSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003AE.html">ActionSamples</a>
</td>
<td>
Gets the objects that are used directly as samples for certain actions.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003AD.html">ActualHttpMessageTypes</a>
</td>
<td>
Gets CLR types that are used as the content of <a target="_top" href=".html" onclick="this.target='';return true;">HttpRequestMessage</a> or <a target="_top" href=".html" onclick="this.target='';return true;">HttpResponseMessage</a>.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003B0.html">SampleObjectFactories</a>
</td>
<td>
Gets factories for the objects that the supported formatters will serialize as samples. Processed in order,
stopping when the factory successfully returns a non-<a target="_top" href="topic_0000000000000513.html" onclick="this.target='';return true;">&lt;default&gt;</a> object.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003AF.html">SampleObjects</a>
</td>
<td>
Gets the objects that are serialized as samples by the supported formatters.
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Methods</a></span>
<div>&nbsp;</div>
</div>
<div id="MethodsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B4.html">GetActionSample(string, string, IEnumerable&lt;String&gt;, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)</a>
</td>
<td>
Search for samples that are provided directly through <a target="_top" href="topic_00000000000003AE.html" onclick="this.target='';return true;">ActionSamples</a>.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B3.html">GetSample(ApiDescription, SampleDirection)</a>
</td>
<td>
Gets the request or response body samples.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B5.html">GetSampleObject(Type)</a>
</td>
<td>
Gets the sample object that will be serialized by the formatters.
First, it will look at the <a target="_top" href="topic_00000000000003AF.html" onclick="this.target='';return true;">SampleObjects</a>. If no sample object is found, it will try to create
one using <a target="_top" href=".html" onclick="this.target='';return true;">DefaultSampleObjectFactory</a> (which wraps an <a target="_top" href="topic_00000000000003D2.html" onclick="this.target='';return true;">ObjectGenerator</a>) and other
factories in <a target="_top" href="topic_00000000000003B0.html" onclick="this.target='';return true;">SampleObjectFactories</a>.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B1.html">GetSampleRequests(ApiDescription)</a>
</td>
<td>
Gets the request body samples for a given <a target="_top" href=".html" onclick="this.target='';return true;">ApiDescription</a>.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B2.html">GetSampleResponses(ApiDescription)</a>
</td>
<td>
Gets the response body samples for a given <a target="_top" href=".html" onclick="this.target='';return true;">ApiDescription</a>.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B6.html">ResolveHttpRequestMessageType(ApiDescription)</a>
</td>
<td>
Resolves the actual type of <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.objectcontent-1">ObjectContent&lt;T&gt;</a> passed to the <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httprequestmessage">HttpRequestMessage</a> in an action.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B7.html">ResolveType(ApiDescription, string, string, IEnumerable&lt;String&gt;, SampleDirection, out Collection&lt;MediaTypeFormatter&gt;)</a>
</td>
<td>
Resolves the type of the action parameter or return value when <a target="_top" href=".html" onclick="this.target='';return true;">HttpRequestMessage</a> or <a target="_top" href=".html" onclick="this.target='';return true;">HttpResponseMessage</a> is used.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_00000000000003B8.html">WriteSampleObjectUsingFormatter(MediaTypeFormatter, object, Type, MediaTypeHeaderValue)</a>
</td>
<td>
Writes the sample object using formatter.
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">Extension Methods</a></span>
<div>&nbsp;</div>
</div>
<div id="ExtensionMethodsSection" class="section">
<table class="memberListTable">
<tr>
<th></th>
<th>
Name
</th>
<th>
Description
</th>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Public extension method" title="Public extension method" src="msdn2019/pubextensionmethod.png"></img>
</td>
<td>
<a href="topic_000000000000033D.html">NameOf(this object)</a>
</td>
<td>
(Defined by <a target="_top" href="topic_000000000000033B.html" onclick="this.target='';return true;">NLogHelper</a>).
</td>
</tr>
</table>
<a href="#mainBody">
Top
</a>
</div>
</div>
<!-- Classes -->
<!-- Classes End -->
<!-- Standard Modules -->
<!-- Standard Modules End -->
@@ -367,6 +871,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
</div>
<div class="section_container">
<div class="section_heading">
<span><a href="javascript:void(0)" title="Collapse" onclick="toggleSection(this);">See Also</a></span>
@@ -375,14 +880,10 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<div id="seeAlsoSection" class="section">
<div>
<a href="topic_00000000000003A0.html">HelpPageSampleKey Class</a><br />
<a href="topic_0000000000000354.html">API_NetFramework.Areas.HelpPage Namespace</a><br />
<a href="topic_000000000000033B.html">API_NetFramework.Areas.HelpPage Namespace</a><br />
</div>
</div>