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.
613 lines
12 KiB
613 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>HelpPageConfigurationExtensions 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">API_NetFramework 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">HelpPageConfigurationExtensions Methods</h1>
|
|
<p />
|
|
<p>
|
|
The following tables list the members exposed by the
|
|
<a href="topic_000000000000001B.html">HelpPageConfigurationExtensions</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> </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>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000002B.html">GetHelpPageApiModel(this HttpConfiguration, string)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000028.html">GetHelpPageSampleGenerator(this HttpConfiguration)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Gets the help page sample generator.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000002A.html">GetModelDescriptionGenerator(this HttpConfiguration)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Gets the model description generator.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000024.html">SetActualRequestType(this HttpConfiguration, Type, string, string)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Specifies the actual type of <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.objectcontent-1">ObjectContent<T></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.
|
|
The help page will use this information to produce more accurate request samples.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000025.html">SetActualRequestType(this HttpConfiguration, Type, string, string, params string[])</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Specifies the actual type of <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.objectcontent-1">ObjectContent<T></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.
|
|
The help page will use this information to produce more accurate request samples.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000026.html">SetActualResponseType(this HttpConfiguration, Type, string, string)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Specifies the actual type of <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.objectcontent-1">ObjectContent<T></a> returned as part of the <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httprequestmessage">HttpRequestMessage</a> in an action.
|
|
The help page will use this information to produce more accurate response samples.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000027.html">SetActualResponseType(this HttpConfiguration, Type, string, string, params string[])</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Specifies the actual type of <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.objectcontent-1">ObjectContent<T></a> returned as part of the <a target="_top" href="https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httprequestmessage">HttpRequestMessage</a> in an action.
|
|
The help page will use this information to produce more accurate response samples.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000001C.html">SetDocumentationProvider(this HttpConfiguration, IDocumentationProvider)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the documentation provider for help page.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000029.html">SetHelpPageSampleGenerator(this HttpConfiguration, HelpPageSampleGenerator)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the help page sample generator.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000022.html">SetSampleForMediaType(this HttpConfiguration, object, MediaTypeHeaderValue)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample directly for all actions with the specified media type.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000023.html">SetSampleForType(this HttpConfiguration, object, MediaTypeHeaderValue, Type)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample directly for all actions with the specified type and media type.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000001D.html">SetSampleObjects(this HttpConfiguration, IDictionary<TypeObject>)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the objects that will be used by the formatters to produce sample requests/responses.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000001E.html">SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample request directly for the specified media type and action.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_000000000000001F.html">SetSampleRequest(this HttpConfiguration, object, MediaTypeHeaderValue, string, string, params string[])</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample request directly for the specified media type and action with parameters.
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000020.html">SetSampleResponse(this HttpConfiguration, object, MediaTypeHeaderValue, string, string)</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample request directly for the specified media type of the action.
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="
|
|
|
|
|
|
">
|
|
<td>
|
|
<img alt="Public method" title="Public method" src="msdn2019/pubmethod.png"></img>
|
|
|
|
<img alt="Static" title="Static" src="msdn2019/static.png"></img>
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<a href="topic_0000000000000021.html">SetSampleResponse(this HttpConfiguration, object, MediaTypeHeaderValue, string, string, params string[])</a>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
Sets the sample response directly for the specified media type of the action with specific parameters.
|
|
|
|
</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> </div>
|
|
</div>
|
|
|
|
<div id="seeAlsoSection" class="section">
|
|
<div>
|
|
<a href="topic_000000000000001B.html">HelpPageConfigurationExtensions Class</a><br />
|
|
<a href="topic_000000000000000B.html">API_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>
|
|
|