You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OnDoc/VSdoc/topic_000000000000034D_meth...

643 lines
12 KiB

<!DOCTYPE html>
<html>
<head>
<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 Methods</title>
<link rel="stylesheet" type="text/css" href="msdn2019/toc.css" />
<script src="msdn2019/toc.js"></script>
<link rel="stylesheet" type="text/css" href="msdn2019/msdn2019.css">
<script src="msdn2019/msdn2019.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shCore_helixoft.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushVb.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushCSharp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushFSharp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushCpp.js" type="text/javascript"></script>
<script src="SyntaxHighlighter/scripts/shBrushJScript.js" type="text/javascript"></script>
<link href="SyntaxHighlighter/styles/shCore.css" rel="stylesheet" type="text/css" />
<link href="SyntaxHighlighter/styles/shThemeMsdnLW.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
SyntaxHighlighter.all();
</script>
<link rel="stylesheet" type="text/css" href="vsdocman_overrides.css">
</head>
<body style="direction: ltr;">
<div id="topic">
<!--HEADER START-->
<div id="header">
<div id="header-top-container">
<div id="header-top-parent-container1">
<div id="header-top-container1">
<div id="runningHeaderText1"><a id="headerLogo" href="#" onclick="window.location.href = getCssCustomProperty('--headerLogoLink'); return false;">logo</a></div>
<div id="runningHeaderText1b"><script>
document.write(getCssCustomProperty('--headerTopCustomLineHtml'));
</script></div>
</div>
</div>
<div id="header-top-container2">
<div id="runningHeaderText">SOLUTION-WIDE PROPERTIES Reference</div>
<div id="search-bar-container">
<form id="search-bar" action="search--.html">
<input id="HeaderSearchInput" type="search" name="search" placeholder="Search" >
<button id="btn-search" class="c-glyph" title="Search">
<span>Search</span>
</button>
</form>
<button id="cancel-search" class="cancel-search" title="Cancel">
<span>Cancel</span>
</button>
</div>
</div>
</div>
<hr />
<div id="header-breadcrumbs"></div>
<div id="headerLinks">
</div>
<hr />
</div>
<!--HEADER END-->
<div id="mainSection">
<div id="toc-area">
<div id="toc-container" class="stickthis full-height">
<div id="-1"></div>
<div id="c-1">
<div id="ci-1" class="inner-for-height"></div>
</div>
</div>
</div>
<div id="mainBody">
<h1 class="title">HelpPageSampleGenerator Methods</h1>
<p />
<p>
The following tables list the members exposed by the
<a href="topic_000000000000034D.html">HelpPageSampleGenerator</a>
type.
</p>
<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="
inheritedMember
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.equals">Equals(Object)</a>
</td>
<td>
Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Protected method" title="Protected method" src="msdn2019/protmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.finalize">Finalize</a>
</td>
<td>
Gibt einem Objekt Gelegenheit zu dem Versuch, Ressourcen freizugeben und andere Bereinigungen durchzuführen, bevor es von der Garbage Collection freigegeben wird.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_0000000000000356.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_0000000000000350.html" onclick="this.target='';return true;">ActionSamples</a>.
</td>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode">GetHashCode</a>
</td>
<td>
Fungiert als die Standardhashfunktion.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_0000000000000355.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_0000000000000357.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_0000000000000351.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_0000000000000374.html" onclick="this.target='';return true;">ObjectGenerator</a>) and other
factories in <a target="_top" href="topic_0000000000000352.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_0000000000000353.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_0000000000000354.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="
inheritedMember
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.gettype">GetType</a>
</td>
<td>
Ruft den <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.type">Type</a> der aktuellen Instanz ab.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Protected method" title="Protected method" src="msdn2019/protmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.memberwiseclone">MemberwiseClone</a>
</td>
<td>
Erstellt eine flache Kopie des aktuellen <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_0000000000000358.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_0000000000000359.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="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httprequestmessage">HttpRequestMessage</a> or <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage">HttpResponseMessage</a> is used.
</td>
</tr>
<tr class="
inheritedMember
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object.tostring">ToString</a>
</td>
<td>
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.
(inherited from <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a>).
</td>
</tr>
<tr class="
">
<td>
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
</td>
<td>
<a href="topic_000000000000035A.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_00000000000002DF.html">NameOf(this object)</a>
</td>
<td>
(Defined by <a target="_top" href="topic_00000000000002DD.html" onclick="this.target='';return true;">NLogHelper</a>).
</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);">See Also</a></span>
<div>&nbsp;</div>
</div>
<div id="seeAlsoSection" class="section">
<div>
<a href="topic_000000000000034D.html">HelpPageSampleGenerator Class</a><br />
<a href="topic_00000000000002F6.html">EDOKAAPI_NetFramework.Areas.HelpPage Namespace</a><br />
</div>
</div>
</div>
</div>
<div id="internal-toc-area">
<div id="internal-toc-container" class="stickthis">
<h3 id="internal-toc-heading">In this article</h3>
<span id="internal-toc-definition-localized-text">Definition</span>
</div>
</div>
</div>
<div id="footer">
<div id="footer-container">
<p>Generated with <a target="_top" href="http://www.helixoft.com/vsdocman/overview.html">VSdocman</a></p>
</div>
</div>
</div>
</body>
</html>