mirror of https://github.com/lidarr/Lidarr
636 lines
47 KiB
XML
636 lines
47 KiB
XML
![]() |
<?xml version="1.0" encoding="utf-8"?>
|
|||
|
<doc>
|
|||
|
<assembly>
|
|||
|
<name>System.Web.Helpers</name>
|
|||
|
</assembly>
|
|||
|
<members>
|
|||
|
<member name="T:System.Web.Helpers.Chart">
|
|||
|
<summary>Displays data as a chart image.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.#ctor(System.Int32,System.Int32,System.String,System.String)">
|
|||
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Helpers.Chart" /> class.</summary>
|
|||
|
<param name="width">The width, in pixels, of the complete chart image.</param>
|
|||
|
<param name="height">The height, in pixels, of the complete chart image.</param>
|
|||
|
<param name="theme">(Optional) The template (theme) to apply to the chart.</param>
|
|||
|
<param name="themePath">(Optional) The template (theme) path and file name to apply to the chart.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.AddLegend(System.String,System.String)">
|
|||
|
<summary>Adds a legend to the chart.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="title">The text of the legend title.</param>
|
|||
|
<param name="name">The unique name of the legend.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.AddSeries(System.String,System.String,System.String,System.String,System.String,System.Int32,System.Collections.IEnumerable,System.String,System.Collections.IEnumerable,System.String)">
|
|||
|
<summary>Provides data points and series attributes for the chart.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="name">The unique name of the series.</param>
|
|||
|
<param name="chartType">The chart type of a series.</param>
|
|||
|
<param name="chartArea">The name of the chart area used to plot the data series.</param>
|
|||
|
<param name="axisLabel">The axis label text for the series.</param>
|
|||
|
<param name="legend">The name of the series associated with the legend.</param>
|
|||
|
<param name="markerStep">A value that determines the granularity to display data point markers.</param>
|
|||
|
<param name="xValue">The values to plot along the X-axis.</param>
|
|||
|
<param name="xField">The name of the field for X-values.</param>
|
|||
|
<param name="yValues">The values to plot along the Y-axis.</param>
|
|||
|
<param name="yFields">A comma-separated list of name or names of the field or fields for Y-values.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.AddTitle(System.String,System.String)">
|
|||
|
<summary>Adds a title to the chart.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="text">The title text.</param>
|
|||
|
<param name="name">The unique name of the title.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.DataBindCrossTable(System.Collections.IEnumerable,System.String,System.String,System.String,System.String,System.String)">
|
|||
|
<summary>Databinds a chart to a data table, with one series created per unique value in a column.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="dataSource">The chart data source.</param>
|
|||
|
<param name="groupByField">The name of the column used to group data into the series.</param>
|
|||
|
<param name="xField">The name of the column for X-values.</param>
|
|||
|
<param name="yFields">A comma-separated list of names of the columns for Y-values.</param>
|
|||
|
<param name="otherFields">Other data point properties that can be bound.</param>
|
|||
|
<param name="pointSortOrder">The order in which the series will be sorted. The default is "Ascending".</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.DataBindTable(System.Collections.IEnumerable,System.String)">
|
|||
|
<summary>Creates and binds series data to the specified data table, and optionally populates multiple Y-values.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="dataSource">The chart data source.</param>
|
|||
|
<param name="xField">The name of the table column used for the series X-values.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.Chart.FileName">
|
|||
|
<summary>Gets or sets the name of the file that contains the chart image.</summary>
|
|||
|
<returns>The name of the file.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.GetBytes(System.String)">
|
|||
|
<summary>Returns a chart image as a byte array.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="format">The image format. The default is "jpeg".</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.GetFromCache(System.String)">
|
|||
|
<summary>Retrieves the specified chart from cache.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="key">The identifier of the cache item that contains the chart to retrieve. The key is set when you call the <see cref="M:System.Web.Helpers.Chart.SaveToCache(System.String,System.Int32,System.Boolean)" /> method.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.Chart.Height">
|
|||
|
<summary>Gets or sets the height of the chart image.</summary>
|
|||
|
<returns>The chart height.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.Save(System.String,System.String)">
|
|||
|
<summary>Saves a chart image to the specified path and file name.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="path">The location and name of the image file.</param>
|
|||
|
<param name="format">The image file format.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.SaveToCache(System.String,System.Int32,System.Boolean)">
|
|||
|
<summary>Saves a chart in the system cache.</summary>
|
|||
|
<returns>Returns <see cref="T:System.String" />.</returns>
|
|||
|
<param name="key">The identifier for the chart in the cache.</param>
|
|||
|
<param name="minutesToCache">The number of minutes to keep the chart image in the cache. The default is 20.</param>
|
|||
|
<param name="slidingExpiration">true to indicate that the chart cache item's expiration is reset each time the item is accessed, or false to indicate that the expiration is based on an absolute interval since the time that the item was added to the cache. </param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.SaveXml(System.String)">
|
|||
|
<summary>Saves a chart as an XML file.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="path">The path and filename to save the XML file to.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.SetXAxis(System.String,System.Double,System.Double)">
|
|||
|
<summary>Sets values for the horizontal axis.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="title">The title of the horizontal axis.</param>
|
|||
|
<param name="min">The minimum value for the horizontal axis.</param>
|
|||
|
<param name="max">The maximum value for the horizontal axis.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.SetYAxis(System.String,System.Double,System.Double)">
|
|||
|
<summary>Sets values for the vertical axis.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="title">The title of the vertical axis.</param>
|
|||
|
<param name="min">The minimum value for the vertical axis.</param>
|
|||
|
<param name="max">The maximum value for the vertical axis.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.ToWebImage(System.String)">
|
|||
|
<summary>Creates a <see cref="T:System.Web.Helpers.WebImage" /> object based on the current <see cref="T:System.Web.Helpers.Chart" /> object.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="format">The format of the image to save the <see cref="T:System.Web.Helpers.WebImage" /> object as. The default is jpeg.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.Chart.Width">
|
|||
|
<summary>Gets or set the width of the chart image.</summary>
|
|||
|
<returns>The chart width.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.Write(System.String)">
|
|||
|
<summary>Renders the output of the <see cref="T:System.Web.Helpers.Chart" /> object as an image.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="format">The format of the image. The default is "jpeg".</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Chart.WriteFromCache(System.String,System.String)">
|
|||
|
<summary>Renders the output of a <see cref="T:System.Web.Helpers.Chart" /> object that has been cached as an image.</summary>
|
|||
|
<returns>The chart.</returns>
|
|||
|
<param name="key">The identifier for the chart in the cache.</param>
|
|||
|
<param name="format">The format of the image. The default is "jpeg".</param>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.ChartTheme"></member>
|
|||
|
<member name="F:System.Web.Helpers.ChartTheme.Blue"></member>
|
|||
|
<member name="F:System.Web.Helpers.ChartTheme.Green"></member>
|
|||
|
<member name="F:System.Web.Helpers.ChartTheme.Vanilla"></member>
|
|||
|
<member name="F:System.Web.Helpers.ChartTheme.Vanilla3D"></member>
|
|||
|
<member name="F:System.Web.Helpers.ChartTheme.Yellow"></member>
|
|||
|
<member name="T:System.Web.Helpers.Crypto">
|
|||
|
<summary>Provides methods to encrypt passwords or other sensitive data.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.GenerateSalt(System.Int32)"></member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.Hash(System.Byte[],System.String)">
|
|||
|
<summary>Returns a hash value for the specified byte array.</summary>
|
|||
|
<returns>The hash value for <paramref name="input" />.</returns>
|
|||
|
<param name="input">The data to provide a hash value for.</param>
|
|||
|
<param name="algorithm">The algorithm used to generate the hash value. The default is "sha256".</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.Hash(System.String,System.String)">
|
|||
|
<summary>Returns a hash value for the specified string.</summary>
|
|||
|
<returns>The hash value for <paramref name="input" />.</returns>
|
|||
|
<param name="input">The data to provide a hash value for.</param>
|
|||
|
<param name="algorithm">The algorithm used to generate the hash value. The default is "sha256".</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.HashPassword(System.String)">
|
|||
|
<summary>Returns a hash value for the specified password.</summary>
|
|||
|
<returns>The hash value for <paramref name="password" />.</returns>
|
|||
|
<param name="password">The password to generate a hash value for.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.SHA1(System.String)"></member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.SHA256(System.String)"></member>
|
|||
|
<member name="M:System.Web.Helpers.Crypto.VerifyHashedPassword(System.String,System.String)"></member>
|
|||
|
<member name="T:System.Web.Helpers.DynamicJsonArray"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.#ctor(System.Object[])"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.GetEnumerator"></member>
|
|||
|
<member name="P:System.Web.Helpers.DynamicJsonArray.Item(System.Int32)"></member>
|
|||
|
<member name="P:System.Web.Helpers.DynamicJsonArray.Length"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.op_Implicit(System.Web.Helpers.DynamicJsonArray)~System.Array"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.op_Implicit(System.Web.Helpers.DynamicJsonArray)~System.Object[]"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.System#Collections#Generic#IEnumerable{T}#GetEnumerator"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.TryConvert(System.Dynamic.ConvertBinder,System.Object@)"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonArray.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)"></member>
|
|||
|
<member name="T:System.Web.Helpers.DynamicJsonObject"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.#ctor(System.Collections.Generic.IDictionary{System.String,System.Object})"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.GetDynamicMemberNames"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.TryConvert(System.Dynamic.ConvertBinder,System.Object@)"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.TryGetIndex(System.Dynamic.GetIndexBinder,System.Object[],System.Object@)"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.TrySetIndex(System.Dynamic.SetIndexBinder,System.Object[],System.Object)"></member>
|
|||
|
<member name="M:System.Web.Helpers.DynamicJsonObject.TrySetMember(System.Dynamic.SetMemberBinder,System.Object)"></member>
|
|||
|
<member name="T:System.Web.Helpers.Json">
|
|||
|
<summary>Provides methods for working with data in JavaScript Object Notation (JSON) format.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Json.Decode``1(System.String)">
|
|||
|
<summary>Converts data in JavaScript Object Notation (JSON) format into the specified strongly typed data list.</summary>
|
|||
|
<returns>The JSON-encoded data converted to a strongly typed list.</returns>
|
|||
|
<param name="value">The JSON-encoded string to convert.</param>
|
|||
|
<typeparam name="T">The type of the strongly typed list to convert JSON data into.</typeparam>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Json.Decode(System.String)">
|
|||
|
<summary>Converts data in JavaScript Object Notation (JSON) format into a data object.</summary>
|
|||
|
<returns>The JSON-encoded data converted to a data object.</returns>
|
|||
|
<param name="value">The JSON-encoded string to convert.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Json.Decode(System.String,System.Type)">
|
|||
|
<summary>Converts data in JavaScript Object Notation (JSON) format into a data object of a specified type.</summary>
|
|||
|
<returns>The JSON-encoded data converted to the specified type.</returns>
|
|||
|
<param name="value">The JSON-encoded string to convert.</param>
|
|||
|
<param name="targetType">The type that the <paramref name="value" /> data should be converted to.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Json.Encode(System.Object)">
|
|||
|
<summary>Converts a data object to a string that is in the JavaScript Object Notation (JSON) format.</summary>
|
|||
|
<returns>Returns a string of data converted to the JSON format.</returns>
|
|||
|
<param name="value">The data object to convert.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.Json.Write(System.Object,System.IO.TextWriter)">
|
|||
|
<summary>Converts a data object to a string in JavaScript Object Notation (JSON) format and adds the string to the specified <see cref="T:System.IO.TextWriter" /> object.</summary>
|
|||
|
<param name="value">The data object to convert.</param>
|
|||
|
<param name="writer">The object that contains the converted JSON data.</param>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.ObjectInfo">
|
|||
|
<summary>Renders the property names and values of the specified object and any subobjects that it references.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.ObjectInfo.Print(System.Object,System.Int32,System.Int32)">
|
|||
|
<summary>Renders the property names and values of the specified object and any subobjects that it references.</summary>
|
|||
|
<returns>For a simple variable, returns the type and the value. For an object that contains multiple items, returns the property name or key, and the value for each property.</returns>
|
|||
|
<param name="value">The object to render information for.</param>
|
|||
|
<param name="depth">Optional. Specifies the depth of nested subobjects to render information for. The default is 10.</param>
|
|||
|
<param name="enumerationLength">Optional. Specifies the maximum number of characters that the method displays for object values. The default is 1000.</param>
|
|||
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|||
|
<paramref name="depth" /> is less than zero.</exception>
|
|||
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|||
|
<paramref name="enumerationLength" /> is less than or equal to zero.</exception>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.ServerInfo">
|
|||
|
<summary>Displays information about the Web server environment that hosts the current Web page.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.ServerInfo.GetHtml">
|
|||
|
<summary>Displays information about the Web server environment.</summary>
|
|||
|
<returns>A string of name-value pairs that contains information about the Web server. </returns>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.SortDirection">
|
|||
|
<summary>Specifies the direction in which to sort a list of items.</summary>
|
|||
|
</member>
|
|||
|
<member name="F:System.Web.Helpers.SortDirection.Ascending">
|
|||
|
<summary>Sort from smallest to largest. For example, from A to Z.</summary>
|
|||
|
</member>
|
|||
|
<member name="F:System.Web.Helpers.SortDirection.Descending">
|
|||
|
<summary>Sort from largest to smallest. For example, from Z to A.</summary>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.WebCache">
|
|||
|
<summary>Provides a cache to store frequently accessed data.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebCache.Get(System.String)">
|
|||
|
<summary>Retrieves the specified item from the <see cref="T:System.Web.Helpers.WebCache" /> object.</summary>
|
|||
|
<returns>The item retrieved from the cache, or null if the item is not found.</returns>
|
|||
|
<param name="key">The identifier for the cache item to retrieve.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebCache.Remove(System.String)">
|
|||
|
<summary>Removes the specified item from the <see cref="T:System.Web.Helpers.WebCache" /> object.</summary>
|
|||
|
<returns>The item removed from the <see cref="T:System.Web.Helpers.WebCache" /> object. If the item is not found, returns null.</returns>
|
|||
|
<param name="key">The identifier for the cache item to remove.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebCache.Set(System.String,System.Object,System.Int32,System.Boolean)">
|
|||
|
<summary>Inserts an item into the <see cref="T:System.Web.Helpers.WebCache" /> object.</summary>
|
|||
|
<param name="key">The identifier for the cache item.</param>
|
|||
|
<param name="value">The data to insert into the cache.</param>
|
|||
|
<param name="minutesToCache">Optional. The number of minutes to keep an item in the cache. The default is 20.</param>
|
|||
|
<param name="slidingExpiration">Optional. true to indicate that the cache item expiration is reset each time the item is accessed, or false to indicate that the expiration is based on an absolute interval since the time that the item was added to the cache. The default is true, which means that, if you also use the default value for the <paramref name="minutesToCache" /> parameter, a cached item expires 20 minutes after it was last accessed.</param>
|
|||
|
<exception cref="T:System.ArgumentOutOfRangeException">The value of <paramref name="minutesToCache" /> is less than or equal to zero.</exception>
|
|||
|
<exception cref="T:System.ArgumentOutOfRangeException">Sliding expiration is enabled and the value of <paramref name="minutesToCache" /> is greater than a year.</exception>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.WebGrid">
|
|||
|
<summary>Displays data using an HTML table.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.#ctor(System.Collections.Generic.IEnumerable{System.Object},System.Collections.Generic.IEnumerable{System.String},System.String,System.Int32,System.Boolean,System.Boolean,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
|
|||
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Helpers.WebGrid" /> class.</summary>
|
|||
|
<param name="source">The data to display.</param>
|
|||
|
<param name="columnNames">A collection of data source column names. By default, this value is auto-populated.</param>
|
|||
|
<param name="defaultSort">The column name that is used to sort the table by default.</param>
|
|||
|
<param name="rowsPerPage">The number of rows that are displayed when paging is displayed. The default is 10.</param>
|
|||
|
<param name="canPage">true to specify that the <see cref="T:System.Web.Helpers.WebGrid" /> object can display paging; otherwise false. The default is true. </param>
|
|||
|
<param name="canSort">true to specify that the <see cref="T:System.Web.Helpers.WebGrid" /> object can sort based on column; otherwise, false. The default is true.</param>
|
|||
|
<param name="ajaxUpdateContainerId">The ID of the HTML element in the <see cref="T:System.Web.Helpers.WebGrid" /> instance that is used for Ajax support in order in order to make partial page updates.</param>
|
|||
|
<param name="ajaxUpdateCallback">The JavaScript function to call after the HTML element specified by the <see cref="P:System.Web.Helpers.WebGrid.AjaxUpdateContainerId" /> property has been updated.</param>
|
|||
|
<param name="fieldNamePrefix">The prefix for query-string fields. This value is used in order to support multiple T:System.Web.Helpers.WebGrid objects on the same page.</param>
|
|||
|
<param name="pageFieldName">The query-string field name for the page number.</param>
|
|||
|
<param name="selectionFieldName">The query-string field name for the selected row number.</param>
|
|||
|
<param name="sortFieldName">The query-string field name for the sort column.</param>
|
|||
|
<param name="sortDirectionFieldName">The query-string field name for the sort direction.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.AjaxUpdateCallback">
|
|||
|
<summary>Gets the name of the JavaScript function to call after the HTML element specified by the <see cref="P:System.Web.Helpers.WebGrid.AjaxUpdateContainerId" /> property has been updated.</summary>
|
|||
|
<returns>The element name.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.AjaxUpdateContainerId">
|
|||
|
<summary>Gets the ID of the HTML element in the <see cref="T:System.Web.Helpers.WebGrid" /> object that is used for Ajax support in order to make partial-page updates.</summary>
|
|||
|
<returns>The element ID.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.Bind(System.Collections.Generic.IEnumerable{System.Object},System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Int32)">
|
|||
|
<summary>Binds the specified data to the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>The populated <see cref="T:System.Web.Helpers.WebGrid" /> object.</returns>
|
|||
|
<param name="source">The data to display.</param>
|
|||
|
<param name="columnNames">The names of the columns to bind.</param>
|
|||
|
<param name="autoSortAndPage">true to enable sorting and paging; otherwise, false.</param>
|
|||
|
<param name="rowCount">The number of rows to display for each page of data.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.Column(System.String,System.String,System.Func`2,System.Boolean,System.Object)">
|
|||
|
<summary>Adds a column object to the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>A column object.</returns>
|
|||
|
<param name="columnName">The name of the column.</param>
|
|||
|
<param name="header">The header of the column.</param>
|
|||
|
<param name="format">A string that specifies the formatting of the column.</param>
|
|||
|
<param name="style">A string that specifies the style of the column.</param>
|
|||
|
<param name="canSort">true if the column can be sorted; otherwise, false. The default is true.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.ColumnNames">
|
|||
|
<summary>Gets a collection of column names from the data source.</summary>
|
|||
|
<returns>The collection of column names.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.Columns(System.Web.Helpers.WebGridColumn[])">
|
|||
|
<summary>Adds a collection of column objects to the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>A set of columns.</returns>
|
|||
|
<param name="columnSet">The columns to add.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.FieldNamePrefix">
|
|||
|
<summary>Gets the prefix for query-string fields of a page.</summary>
|
|||
|
<returns>The prefix for query-string fields.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.GetContainerUpdateScript(System.String)">
|
|||
|
<summary>Converts a URL into a jQuery Ajax call.</summary>
|
|||
|
<returns>A script used as a jQuery Ajax call.</returns>
|
|||
|
<param name="path">The URL to convert.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.GetHtml(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,System.Collections.Generic.IEnumerable{System.Web.Helpers.WebGridColumn},System.Collections.Generic.IEnumerable{System.String},System.Web.Helpers.WebGridPagerModes,System.String,System.String,System.String,System.String,System.Int32,System.Object)">
|
|||
|
<summary>Returns HTML that is used to render the <see cref="T:System.Web.Helpers.WebGrid" /> instance.</summary>
|
|||
|
<returns>The HTML that represents the populated <see cref="T:System.Web.Helpers.WebGrid" /> object.</returns>
|
|||
|
<param name="tableStyle">The CSS class to use to style the table.</param>
|
|||
|
<param name="headerStyle">The CSS class to use to style the header row of the table.</param>
|
|||
|
<param name="footerStyle">The CSS class to use to style the footer row of the table.</param>
|
|||
|
<param name="rowStyle">The CSS class to use to style each row of the table.</param>
|
|||
|
<param name="alternatingRowStyle">The CSS class to use to style the even rows of the table.</param>
|
|||
|
<param name="selectedRowStyle">The CSS class to use to style the selected rows of the table.</param>
|
|||
|
<param name="caption">The caption for the table.</param>
|
|||
|
<param name="displayHeader">true to specify that the header of the table is displayed; otherwise, false. The default is true.</param>
|
|||
|
<param name="fillEmptyRows">true to specify that the table can add empty rows to ensure the <see cref="P:System.Web.Helpers.WebGrid.RowsPerPage" /> row count is maintained; otherise, false. The default is false.</param>
|
|||
|
<param name="emptyRowCellValue">The text that is used to populate empty rows. The <paramref name="fillEmptyRows" /> parameter must be set to true to display this value.</param>
|
|||
|
<param name="columns">The column model for customizing column rendering.</param>
|
|||
|
<param name="exclusions">The columns to exclude when auto-populating columns.</param>
|
|||
|
<param name="mode">A <see cref="T:System.Web.Helpers.WebGridPagerModes" /> value specifying the mode for rendering paging support.</param>
|
|||
|
<param name="firstText">The text for the link to the first page.</param>
|
|||
|
<param name="previousText">The text for the link to the previous page.</param>
|
|||
|
<param name="nextText">The text for the link to the next page.</param>
|
|||
|
<param name="lastText">The text for the link to the last page.</param>
|
|||
|
<param name="numericLinksCount">The number of numeric links to display.</param>
|
|||
|
<param name="htmlAttributes">An object that contains the HTML attributes to set for the element.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.GetPageUrl(System.Int32)">
|
|||
|
<summary>Returns the URL of the page that the <see cref="T:System.Web.Helpers.WebGrid" /> object will display based on the specified page index.</summary>
|
|||
|
<returns>The URL of the page that the <see cref="T:System.Web.Helpers.WebGrid" /> object will display.</returns>
|
|||
|
<param name="pageIndex">The index of the page to display.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.GetSortUrl(System.String)">
|
|||
|
<summary>Returns a URL used to display the sorted data in the <see cref="T:System.Web.Helpers.WebGrid" /> object based on a column name.</summary>
|
|||
|
<returns>The url used to display the sorted data.</returns>
|
|||
|
<param name="column">The name of the column to sort the grid by.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.HasSelection">
|
|||
|
<summary>Gets a value that determines whether any row in the <see cref="T:System.Web.Helpers.WebGrid" /> object has been selected.</summary>
|
|||
|
<returns>true if a row has been selected; otherwise, false.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.PageCount">
|
|||
|
<summary>Gets the number of pages that the <see cref="T:System.Web.Helpers.WebGrid" /> object has available to display.</summary>
|
|||
|
<returns>The page count.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.PageFieldName">
|
|||
|
<summary>Gets the query string field name for the page number of the WebGrid.</summary>
|
|||
|
<returns>The column name.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.PageIndex">
|
|||
|
<summary>Gets or sets the index of the current page to display.</summary>
|
|||
|
<returns>The current page index.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.Pager(System.Web.Helpers.WebGridPagerModes,System.String,System.String,System.String,System.String,System.Int32)">
|
|||
|
<summary>Returns the HTML that is required to provide paging support.</summary>
|
|||
|
<param name="mode">A <see cref="T:System.Web.Helpers.WebGridPagerModes" /> value that specifies paging support.</param>
|
|||
|
<param name="firstText">The text for the link to the first page.</param>
|
|||
|
<param name="previousText">The text for the link to the previous page.</param>
|
|||
|
<param name="nextText">The text for the link to the next page.</param>
|
|||
|
<param name="lastText">The test for the link to the last page.</param>
|
|||
|
<param name="numericLinksCount">The number of numeric links to display.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.Rows">
|
|||
|
<summary>Gets a list of rows that are in the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>The collection of rows.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.RowsPerPage">
|
|||
|
<summary>Gets the number of rows to display on each page.</summary>
|
|||
|
<returns>The row count for a page.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SelectedIndex">
|
|||
|
<summary>Gets or sets the index of the selected row.</summary>
|
|||
|
<returns>The row index.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SelectedRow">
|
|||
|
<summary>Gets the selected row of the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>The selected row.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SelectionFieldName">
|
|||
|
<summary>Gets the query string field name for the selected row number of the WebGrid.</summary>
|
|||
|
<returns>The name of the selected column.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SortColumn">
|
|||
|
<summary>Gets or sets the name of the column that is used to sort the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>The name of the sort column.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SortDirection">
|
|||
|
<summary>Gets or sets the direction that the <see cref="T:System.Web.Helpers.WebGrid" /> object is sorted.</summary>
|
|||
|
<returns>The sort direction.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SortDirectionFieldName">
|
|||
|
<summary>Gets the query string field name for the sort direction of the WebGrid. </summary>
|
|||
|
<returns>The column prefix and name.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.SortFieldName">
|
|||
|
<summary>Gets the query string field name for the sort column of the WebGrid. </summary>
|
|||
|
<returns>The sort column name.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebGrid.Table(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,System.Collections.Generic.IEnumerable{System.Web.Helpers.WebGridColumn},System.Collections.Generic.IEnumerable{System.String},System.Func`2,System.Boolean)">
|
|||
|
<summary>Returns the HTML that is used to render the <see cref="T:System.Web.Helpers.WebGrid" /> instance that supports paging.</summary>
|
|||
|
<returns>The HTML that represents the populated <see cref="T:System.Web.Helpers.WebGrid" /> object.</returns>
|
|||
|
<param name="tableStyle">The CSS class to use to style the table.</param>
|
|||
|
<param name="headerStyle">The CSS class to use to style the header row.</param>
|
|||
|
<param name="footerStyle">The CSS class to use to style the footer row.</param>
|
|||
|
<param name="rowStyle">The CSS class to use to style odd rows.</param>
|
|||
|
<param name="alternatingRowStyle">The CSS class to use to style even rows.</param>
|
|||
|
<param name="selectedRowStyle">The CSS class used to use to style the selected row.</param>
|
|||
|
<param name="caption">The caption for the table.</param>
|
|||
|
<param name="displayHeader">true to specify that the header of the table is displayed; otherwise, false. The default is true.</param>
|
|||
|
<param name="fillEmptyRows">true to specify that the table can add empty rows to ensure the <see cref="P:System.Web.Helpers.WebGrid.RowsPerPage" /> row count is maintained; otherise, false. The default is false.</param>
|
|||
|
<param name="emptyRowCellValue">The text that is used to populate empty rows. The <paramref name="fillEmptyRows" /> parameter must be set to true to display this value.</param>
|
|||
|
<param name="columns">The column model that is used to customize column rendering.</param>
|
|||
|
<param name="exclusions">The columns to exclude when auto-populating columns.</param>
|
|||
|
<param name="footer">The table footer template.</param>
|
|||
|
<param name="htmlAttributes">An object that contains the HTML attributes to set for the element.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebGrid.TotalRowCount">
|
|||
|
<summary>Gets the total row count for the <see cref="T:System.Web.Helpers.WebGrid" /> object.</summary>
|
|||
|
<returns>The row count.</returns>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.WebGridColumn"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridColumn.#ctor"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridColumn.CanSort"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridColumn.ColumnName"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridColumn.Format"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridColumn.Header"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridColumn.Style"></member>
|
|||
|
<member name="T:System.Web.Helpers.WebGridPagerModes"></member>
|
|||
|
<member name="F:System.Web.Helpers.WebGridPagerModes.Numeric">
|
|||
|
<summary />
|
|||
|
</member>
|
|||
|
<member name="F:System.Web.Helpers.WebGridPagerModes.NextPrevious">
|
|||
|
<summary />
|
|||
|
</member>
|
|||
|
<member name="F:System.Web.Helpers.WebGridPagerModes.FirstLast">
|
|||
|
<summary />
|
|||
|
</member>
|
|||
|
<member name="F:System.Web.Helpers.WebGridPagerModes.All">
|
|||
|
<summary />
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.WebGridRow"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.#ctor(System.Web.Helpers.WebGrid,System.Object,System.Int32)"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.GetEnumerator"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.GetSelectLink(System.String)"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.GetSelectUrl"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridRow.Item(System.Int32)"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridRow.Item(System.String)"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.System#Collections#IEnumerable#GetEnumerator"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.ToString"></member>
|
|||
|
<member name="M:System.Web.Helpers.WebGridRow.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridRow.Value"></member>
|
|||
|
<member name="P:System.Web.Helpers.WebGridRow.WebGrid"></member>
|
|||
|
<member name="T:System.Web.Helpers.WebImage">
|
|||
|
<summary>Represents an object that lets you display and manage images in in a Web page.</summary>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.#ctor(System.Byte[])">
|
|||
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Helpers.WebImage" /> class using a byte array to represent the image.</summary>
|
|||
|
<param name="content">The image.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.#ctor(System.IO.Stream)">
|
|||
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Helpers.WebImage" /> class using a stream to represent the image.</summary>
|
|||
|
<param name="imageStream">The image.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.#ctor(System.String)">
|
|||
|
<summary>Initializes a new instance of the <see cref="T:System.Web.Helpers.WebImage" /> class using a path to represent the image location.</summary>
|
|||
|
<param name="filePath">The path of the file that contains the image.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.AddImageWatermark(System.String,System.Int32,System.Int32,System.String,System.String,System.Int32,System.Int32)">
|
|||
|
<summary>Adds a watermark image to the image using the specified image file.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="watermarkImageFilePath">The path of a file that contains the image.</param>
|
|||
|
<param name="width">The width, in pixels, of the watermark image.</param>
|
|||
|
<param name="height">The height, in pixels, of the watermark image.</param>
|
|||
|
<param name="horizontalAlign">The horizontal alignment for watermark image. Values can be left, right, or center.</param>
|
|||
|
<param name="verticalAlign">The vertical alignment for the watermark image. Values can be top, bottom, or middle.</param>
|
|||
|
<param name="opacity">The opacity for the watermark image, specified as a value between 0 and 100.</param>
|
|||
|
<param name="padding">The size, in pixels, of the padding around the watermark image.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.AddImageWatermark(System.Web.Helpers.WebImage,System.Int32,System.Int32,System.String,System.String,System.Int32,System.Int32)">
|
|||
|
<summary>Adds a watermark image to the image using the specified <see cref="T:System.Web.Helpers.WebImage" /> object.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="watermarkImage">A <see cref="T:System.Web.Helpers.WebImage" /> object.</param>
|
|||
|
<param name="width">The width, in pixels, of the watermark image.</param>
|
|||
|
<param name="height">The height, in pixels, of the watermark image.</param>
|
|||
|
<param name="horizontalAlign">The horizontal alignment for watermark image. Values can be left, right, or center.</param>
|
|||
|
<param name="verticalAlign">The vertical alignment for the watermark image. Values can be top, bottom, or middle.</param>
|
|||
|
<param name="opacity">The opacity for the watermark image specifies as a value between 0 and 100.</param>
|
|||
|
<param name="padding">The size, in pixels, of the padding around the watermark image.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.AddTextWatermark(System.String,System.String,System.Int32,System.String,System.String,System.String,System.String,System.Int32,System.Int32)">
|
|||
|
<summary>Adds watermark text to the image.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="text">The text to use as a watermark.</param>
|
|||
|
<param name="fontColor">The color of the watermark text.</param>
|
|||
|
<param name="fontSize">The font size of the watermark text.</param>
|
|||
|
<param name="fontStyle">The font style of the watermark text.</param>
|
|||
|
<param name="fontFamily">The font type of the watermark text.</param>
|
|||
|
<param name="horizontalAlign">The horizontal alignment for watermark text. Values can be left, right, or center.</param>
|
|||
|
<param name="verticalAlign">The vertical alignment for the watermark text. Values can be top, bottom, or middle.</param>
|
|||
|
<param name="opacity">The text opacity for the watermark text specified as a value between 0 and 100.</param>
|
|||
|
<param name="padding">The size, in pixels, of the padding around the watermark text.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.Clone">
|
|||
|
<summary>Copies the <see cref="T:System.Web.Helpers.WebImage" /> object.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.Crop(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|||
|
<summary>Crops an image.</summary>
|
|||
|
<returns>The cropped image.</returns>
|
|||
|
<param name="top">The number of pixels to remove from the top.</param>
|
|||
|
<param name="left">The number of pixels to remove from the left.</param>
|
|||
|
<param name="bottom">The number of pixels to remove from the bottom.</param>
|
|||
|
<param name="right">The number of pixels to remove from the right.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebImage.FileName">
|
|||
|
<summary>Gets or sets the name of the file used by the <see cref="T:System.Web.Helpers.WebImage" /> object.</summary>
|
|||
|
<returns>The file name</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.FlipHorizontal">
|
|||
|
<summary>Flips an image horizontally.</summary>
|
|||
|
<returns>The flipped image.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.FlipVertical">
|
|||
|
<summary>Flips an image vertically.</summary>
|
|||
|
<returns>The flipped image.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.GetBytes(System.String)">
|
|||
|
<summary>Returns the image as a byte array.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="requestedFormat">The <see cref="P:System.Web.Helpers.WebImage.ImageFormat" /> of the <see cref="T:System.Web.Helpers.WebImage" /> object.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.GetImageFromRequest(System.String)">
|
|||
|
<summary>Returns an image that has been uploaded using the browser.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="postedFileName">(Optional) The name of the file that has been posted.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebImage.Height">
|
|||
|
<summary>Gets the height, in pixels, of the image.</summary>
|
|||
|
<returns>The height.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebImage.ImageFormat">
|
|||
|
<summary>Gets the format of the image (for example, JPEG or PNG).</summary>
|
|||
|
<returns>The format.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.Resize(System.Int32,System.Int32,System.Boolean,System.Boolean)">
|
|||
|
<summary>Resizes an image.</summary>
|
|||
|
<returns>The resized image.</returns>
|
|||
|
<param name="width">The width, in pixels, of the <see cref="T:System.Web.Helpers.WebImage" /> object.</param>
|
|||
|
<param name="height">The height, in pixels, of the <see cref="T:System.Web.Helpers.WebImage" /> object.</param>
|
|||
|
<param name="preserveAspectRatio">true to preserve the aspect ratio of the image; otherwise, false.</param>
|
|||
|
<param name="preventEnlarge">true to prevent the enlargement of the image; otherwise, false.</param>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.RotateLeft">
|
|||
|
<summary>Rotates an image to the left.</summary>
|
|||
|
<returns>The rotated image.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.RotateRight">
|
|||
|
<summary>Rotates an image to the right.</summary>
|
|||
|
<returns>The rotated image.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.Save(System.String,System.String,System.Boolean)">
|
|||
|
<summary>Saves the image using the specified file name.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="filePath">The path to save the image to.</param>
|
|||
|
<param name="imageFormat">The format used when saving the image file.</param>
|
|||
|
<param name="forceCorrectExtension">true to force that the correct file extension is used for the format specified in <paramref name="imageFormat" />; otherwise, false.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebImage.Width">
|
|||
|
<summary>Gets the width, in pixels, of the image.</summary>
|
|||
|
<returns>The width.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebImage.Write(System.String)">
|
|||
|
<summary>Renders an image to the browser to be displayed.</summary>
|
|||
|
<returns>The image.</returns>
|
|||
|
<param name="requestedFormat">(Optional) The file format.</param>
|
|||
|
</member>
|
|||
|
<member name="T:System.Web.Helpers.WebMail">
|
|||
|
<summary>Provides a way to construct and send an email message using Simple Mail Transfer Protocol (SMTP).</summary>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.EnableSsl">
|
|||
|
<summary>Gets or sets whether Secure Sockets Layer (SSL) is used to encrypt the connection when sending email.</summary>
|
|||
|
<returns>true if SSL is used to encrypt the connection; otherwise, false.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.From">
|
|||
|
<summary>Gets or sets the email address of the sender.</summary>
|
|||
|
<returns>The email address of the sender.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.Password">
|
|||
|
<summary>Gets or sets the sender’s password based on the email account used.</summary>
|
|||
|
<returns>The password of the sender.</returns>
|
|||
|
</member>
|
|||
|
<member name="M:System.Web.Helpers.WebMail.Send(System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Collections.Generic.IEnumerable{System.String})">
|
|||
|
<summary>Sends the specified message to an SMTP server for delivery.</summary>
|
|||
|
<param name="to">The recipients of this email message. Multiple recipients can be specified by separating them using a semicolon (;).</param>
|
|||
|
<param name="subject">The subject line for the email message.</param>
|
|||
|
<param name="body">The body of the email message. If <paramref name="isBodyHtml" /> is true, HTML in the body is interpreted as markup.</param>
|
|||
|
<param name="from">The email address of the message sender.</param>
|
|||
|
<param name="cc">The carbon copy (CC) recipients for the email message, if any.</param>
|
|||
|
<param name="filesToAttach">A collection of file names that specifies the files to attach to the email message.</param>
|
|||
|
<param name="isBodyHtml">true to specify that the email message body is in HTML format; false to indicate that the body is in plain-text format.</param>
|
|||
|
<param name="additionalHeaders">A collection of headers that are sent with this email message.</param>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.SmtpPort">
|
|||
|
<summary>Gets or sets the port used for SMTP transactions.</summary>
|
|||
|
<returns>The port used for SMTP transactions.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.SmtpServer">
|
|||
|
<summary>Gets or sets the SMTP server used to transmit the email message.</summary>
|
|||
|
<returns>The SMTP server.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.SmtpUseDefaultCredentials">
|
|||
|
<summary>Gets or sets a value that indicates whether the default credentials are sent with the requests.</summary>
|
|||
|
<returns>true if credentials are sent with the email message; otherwise, false.</returns>
|
|||
|
</member>
|
|||
|
<member name="P:System.Web.Helpers.WebMail.UserName">
|
|||
|
<summary>Gets or sets the name of email account name used to send email.</summary>
|
|||
|
<returns>The name of the user.</returns>
|
|||
|
</member>
|
|||
|
</members>
|
|||
|
</doc>
|