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

478
VSdoc/topic_000000000000039F.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>HelpPageSampleGenerator.WriteSampleObjectUsingFormatter Method</title>
<title>HelpPageApiModel 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">HelpPageSampleGenerator.WriteSampleObjectUsingFormatter Method</h1>
<h1 class="title">HelpPageApiModel Class</h1>
<div class="metadata">
Namespace:
<a href="topic_000000000000033B.html">API_NetFramework.Areas.HelpPage</a>
<a href="topic_000000000000039E.html">API_NetFramework.Areas.HelpPage.Models</a>
@@ -89,7 +89,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<summary-info>Writes the sample object using formatter.</summary-info>
<summary-info>The model that represents an API displayed on the help page.</summary-info>
@@ -139,7 +139,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeVB">
<pre xml:space="preserve" class="brush: vb">&lt;SuppressMessage(&quot;Microsoft.Design&quot;, &quot;CA1031:DoNotCatchGeneralExceptionTypes&quot;, Justification = &quot;The exception is recorded as InvalidSample.&quot;)&gt; _&nbsp;<br />Public Overridable Function WriteSampleObjectUsingFormatter( _&nbsp;<br /> ByVal <i>formatter</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.formatting.mediatypeformatter">MediaTypeFormatter</a>, _&nbsp;<br /> ByVal <i>value</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>, _&nbsp;<br /> ByVal <i>type</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a>, _&nbsp;<br /> ByVal <i>mediaType</i> As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.mediatypeheadervalue">MediaTypeHeaderValue</a> _&nbsp;<br />) As <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a></pre>
<pre xml:space="preserve" class="brush: vb">Public Class HelpPageApiModel</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -178,7 +178,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCsharp">
<pre xml:space="preserve" class="brush: csharp">[SuppressMessage(&quot;Microsoft.Design&quot;, &quot;CA1031:DoNotCatchGeneralExceptionTypes&quot;, Justification = &quot;The exception is recorded as InvalidSample.&quot;)]&nbsp;<br />public virtual <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a> WriteSampleObjectUsingFormatter(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.formatting.mediatypeformatter">MediaTypeFormatter</a> <i>formatter</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a> <i>value</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a> <i>type</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.mediatypeheadervalue">MediaTypeHeaderValue</a> <i>mediaType</i>&nbsp;<br />)</pre>
<pre xml:space="preserve" class="brush: csharp">public class HelpPageApiModel</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -218,7 +218,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeCpp">
<pre xml:space="preserve" class="brush: cpp">[SuppressMessage(&quot;Microsoft.Design&quot;, &quot;CA1031:DoNotCatchGeneralExceptionTypes&quot;, Justification = &quot;The exception is recorded as InvalidSample.&quot;)]&nbsp;<br />public: &nbsp;<br />virtual <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>^ WriteSampleObjectUsingFormatter(&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.formatting.mediatypeformatter">MediaTypeFormatter</a>^ <i>formatter</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>^ <i>value</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a>^ <i>type</i>,&nbsp;<br /> <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.mediatypeheadervalue">MediaTypeHeaderValue</a>^ <i>mediaType</i>&nbsp;<br />) </pre>
<pre xml:space="preserve" class="brush: cpp">public ref class HelpPageApiModel </pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -257,7 +257,7 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<div class="codeSnippetCode codeJScript">
<pre xml:space="preserve" class="brush: js">public &nbsp;<br /> SuppressMessage(&quot;Microsoft.Design&quot;, &quot;CA1031:DoNotCatchGeneralExceptionTypes&quot;, Justification = &quot;The exception is recorded as InvalidSample.&quot;)&nbsp;<br />function WriteSampleObjectUsingFormatter(&nbsp;<br /> <i>formatter</i> : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.formatting.mediatypeformatter">MediaTypeFormatter</a>,&nbsp;<br /> <i>value</i> : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>,&nbsp;<br /> <i>type</i> : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a>,&nbsp;<br /> <i>mediaType</i> : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.mediatypeheadervalue">MediaTypeHeaderValue</a>&nbsp;<br />) : <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>;</pre>
<pre xml:space="preserve" class="brush: js">public class HelpPageApiModel</pre>
</div>
<div class="codeSnippetCode codeNA">
<pre xml:space="preserve">This language is not supported or no code example is available.</pre>
@@ -268,66 +268,6 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</div>
<h4 class="subHeading">
Parameters</h4><dl paramName="formatter" class="parameterList">
<dt>
<span class="parameter">
formatter
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.formatting.mediatypeformatter">MediaTypeFormatter</a>
</dd>
</dl>
<p>
The formatter.
</p>
<dl paramName="value" class="parameterList">
<dt>
<span class="parameter">
value
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>
</dd>
</dl>
<p>
The value.
</p>
<dl paramName="type" class="parameterList">
<dt>
<span class="parameter">
type
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a>
</dd>
</dl>
<p>
The type.
</p>
<dl paramName="mediaType" class="parameterList">
<dt>
<span class="parameter">
mediaType
</span>
</dt>
<dd>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.headers.mediatypeheadervalue">MediaTypeHeaderValue</a>
</dd>
</dl>
<p>
Type of the media.
</p>
<p />
<h4 class="subHeading">
Return Value</h4>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">object</a>
@@ -347,6 +287,399 @@ 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_00000000000003A0.html">HelpPageApiModel()</a>
</td>
<td>
Initializes a new instance of the <a target="_top" href="topic_000000000000039F.html" onclick="this.target='';return true;">HelpPageApiModel</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_00000000000003A1.html">ApiDescription</a>
</td>
<td>
Gets or sets the <a target="_top" href="topic_00000000000003A1.html" onclick="this.target='';return true;">ApiDescription</a> that describes the API.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003AA.html">ErrorMessages</a>
</td>
<td>
Gets the error messages associated with this model.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A5.html">RequestBodyParameters</a>
</td>
<td>
Gets the request body parameter descriptions.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A3.html">RequestDocumentation</a>
</td>
<td>
Gets or sets the documentation for the request.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A4.html">RequestModelDescription</a>
</td>
<td>
Gets or sets the <a target="_top" href="topic_0000000000000389.html" onclick="this.target='';return true;">ModelDescription</a> that describes the request body.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A6.html">ResourceDescription</a>
</td>
<td>
Gets or sets the <a target="_top" href="topic_0000000000000389.html" onclick="this.target='';return true;">ModelDescription</a> that describes the resource.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A7.html">ResourceProperties</a>
</td>
<td>
Gets the resource property descriptions.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A8.html">SampleRequests</a>
</td>
<td>
Gets the sample requests associated with the API.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A9.html">SampleResponses</a>
</td>
<td>
Gets the sample responses associated with the API.
</td>
</tr>
<tr class="
">
<td>
<img alt="Public property" title="Public property" src="msdn2019/pubproperty.png"></img>
</td>
<td>
<a href="topic_00000000000003A2.html">UriParameters</a>
</td>
<td>
Gets or sets the <a target="_top" href="topic_0000000000000397.html" onclick="this.target='';return true;">ParameterDescription</a> collection that describes the URI parameters for the API.
</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 -->
@@ -407,6 +740,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>
@@ -415,14 +749,10 @@ document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
<div id="seeAlsoSection" class="section">
<div>
<a href="topic_0000000000000392.html">HelpPageSampleGenerator Class</a><br />
<a href="topic_000000000000039E.html">API_NetFramework.Areas.HelpPage.Models Namespace</a><br />
<a href="topic_000000000000033B.html">API_NetFramework.Areas.HelpPage Namespace</a><br />
</div>
</div>