System.Web.Helpers

Displays data in the form of a graphical chart.

Initializes a new instance of the class.

The width, in pixels, of the complete chart image. The height, in pixels, of the complete chart image. (Optional) The template (theme) to apply to the chart. (Optional) The template (theme) path and file name to apply to the chart.

Adds a legend to the chart.

The chart. The text of the legend title. The unique name of the legend.

Provides data points and series attributes for the chart.

The chart. The unique name of the series. The chart type of a series. The name of the chart area that is used to plot the data series. The axis label text for the series. The name of the series that is associated with the legend. The granularity of data point markers. The values to plot along the x-axis. The name of the field for x-values. The values to plot along the y-axis. A comma-separated list of name or names of the field or fields for y-values.

Adds a title to the chart.

The chart. The title text. The unique name of the title.

Binds a chart to a data table, where one series is created for each unique value in a column.

The chart. The chart data source. The name of the column that is used to group data into the series. The name of the column for x-values. A comma-separated list of names of the columns for y-values. Other data point properties that can be bound. The order in which the series will be sorted. The default is "Ascending".

Creates and binds series data to the specified data table, and optionally populates multiple x-values.

The chart. The chart data source. This can be can be any object. The name of the table column used for the series x-values.

Gets or sets the name of the file that contains the chart image.

The name of the file.

Returns a chart image as a byte array.

The chart. The image format. The default is "jpeg".

Retrieves the specified chart from the cache.

The chart. The ID of the cache item that contains the chart to retrieve. The key is set when you call the method.

Gets or sets the height, in pixels, of the chart image.

The chart height.

Saves a chart image to the specified file.

The chart. The location and name of the image file. The image file format, such as "png" or "jpeg".

Saves a chart in the system cache.

The ID of the cache item that contains the chart. The ID of the chart in the cache. The number of minutes to keep the chart image in the cache. The default is 20. 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. The default is true.

Saves a chart as an XML file.

The chart. The path and name of the XML file.

Sets values for the horizontal axis.

The chart. The title of the x-axis. The minimum value for the x-axis. The maximum value for the x-axis.

Sets values for the vertical axis.

The chart. The title of the y-axis. The minimum value for the y-axis. The maximum value for the y-axis.

Creates a object based on the current object.

The chart. The format of the image to save the object as. The default is "jpeg". The parameter is not case sensitive.

Gets or set the width, in pixels, of the chart image.

The chart width.

Renders the output of the object as an image.

The chart. The format of the image. The default is "jpeg".

Renders the output of a object that has been cached as an image.

The chart. The ID of the chart in the cache. The format of the image. The default is "jpeg".

Specifies visual themes for a object.

A theme for 2D charting that features a visual container with a blue gradient, rounded edges, drop-shadowing, and high-contrast gridlines.

A theme for 2D charting that features a visual container with a green gradient, rounded edges, drop-shadowing, and low-contrast gridlines.

A theme for 2D charting that features no visual container and no gridlines.

A theme for 3D charting that features no visual container, limited labeling and, sparse, high-contrast gridlines.

A theme for 2D charting that features a visual container that has a yellow gradient, rounded edges, drop-shadowing, and high-contrast gridlines.

Provides methods to generate hash values and encrypt passwords or other sensitive data.

Generates a cryptographically strong sequence of random byte values.

The generated salt value as a base-64-encoded string. The number of cryptographically random bytes to generate.

Returns a hash value for the specified byte array.

The hash value for as a string of hexadecimal characters. The data to provide a hash value for. The algorithm that is used to generate the hash value. The default is "sha256". is null.

Returns a hash value for the specified string.

The hash value for as a string of hexadecimal characters. The data to provide a hash value for. The algorithm that is used to generate the hash value. The default is "sha256". is null.

Returns an RFC 2898 hash value for the specified password.

The hash value for as a base-64-encoded string. The password to generate a hash value for. is null.

Returns a SHA-1 hash value for the specified string.

The SHA-1 hash value for as a string of hexadecimal characters. The data to provide a hash value for. is null.

Returns a SHA-256 hash value for the specified string.

The SHA-256 hash value for as a string of hexadecimal characters. The data to provide a hash value for. is null.

Determines whether the specified RFC 2898 hash and password are a cryptographic match.

true if the hash value is a cryptographic match for the password; otherwise, false. The previously-computed RFC 2898 hash value as a base-64-encoded string. The plaintext password to cryptographically compare with . or is null.

Represents a series of values as a JavaScript-like array by using the dynamic capabilities of the Dynamic Language Runtime (DLR).

Initializes a new instance of the class using the specified array element values.

An array of objects that contains the values to add to the instance.

Returns an enumerator that can be used to iterate through the elements of the instance.

An enumerator that can be used to iterate through the elements of the JSON array.

Returns the value at the specified index in the instance.

The value at the specified index. The zero-based index of the value in the JSON array to return.

Returns the number of elements in the instance.

The number of elements in the JSON array.

Converts a instance to an array of objects.

The array of objects that represents the JSON array. The JSON array to convert.

Converts a instance to an array of objects.

The array of objects that represents the JSON array. The JSON array to convert.

Returns an enumerator that can be used to iterate through a collection.

An enumerator that can be used to iterate through the collection.

Converts the instance to a compatible type.

true if the conversion was successful; otherwise, false. Provides information about the conversion operation. When this method returns, contains the result of the type conversion operation. This parameter is passed uninitialized.

Tests the instance for dynamic members (which are not supported) in a way that does not cause an exception to be thrown.

true in all cases. Provides information about the get operation. When this method returns, contains null. This parameter is passed uninitialized.

Represents a collection of values as a JavaScript-like object by using the capabilities of the Dynamic Language Runtime.

Initializes a new instance of the class using the specified field values.

A dictionary of property names and values to add to the instance as dynamic members.

Returns a list that contains the name of all dynamic members (JSON fields) of the instance.

A list that contains the name of every dynamic member (JSON field).

Converts the instance to a compatible type.

true in all cases. Provides information about the conversion operation. When this method returns, contains the result of the type conversion operation. This parameter is passed uninitialized. The instance could not be converted to the specified type.

Gets the value of a field using the specified index.

true in all cases. Provides information about the indexed get operation. An array that contains a single object that indexes the field by name. The object must be convertible to a string that specifies the name of the JSON field to return. If multiple indexes are specified, contains null when this method returns. When this method returns, contains the value of the indexed field, or null if the get operation was unsuccessful. This parameter is passed uninitialized.

Gets the value of a field using the specified name.

true in all cases. Provides information about the get operation. When this method returns, contains the value of the field, or null if the get operation was unsuccessful. This parameter is passed uninitialized.

Sets the value of a field using the specified index.

true in all cases. Provides information about the indexed set operation. An array that contains a single object that indexes the field by name. The object must be convertible to a string that specifies the name of the JSON field to return. If multiple indexes are specified, no field is changed or added. The value to set the field to.

Sets the value of a field using the specified name.

true in all cases. Provides information about the set operation. The value to set the field to.

Provides methods for working with data in JavaScript Object Notation (JSON) format.

Converts data in JavaScript Object Notation (JSON) format into the specified strongly typed data list.

The JSON-encoded data converted to a strongly typed list. The JSON-encoded string to convert. The type of the strongly typed list to convert JSON data into.

Converts data in JavaScript Object Notation (JSON) format into a data object.

The JSON-encoded data converted to a data object. The JSON-encoded string to convert.

Converts data in JavaScript Object Notation (JSON) format into a data object of a specified type.

The JSON-encoded data converted to the specified type. The JSON-encoded string to convert. The type that the data should be converted to.

Converts a data object to a string that is in the JavaScript Object Notation (JSON) format.

Returns a string of data converted to the JSON format. The data object to convert.

Converts a data object to a string in JavaScript Object Notation (JSON) format and adds the string to the specified object.

The data object to convert. The object that contains the converted JSON data.

Renders the property names and values of the specified object and of any subobjects that it references.

Renders the property names and values of the specified object and of any subobjects.

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. The object to render information for. Optional. Specifies the depth of nested subobjects to render information for. The default is 10. Optional. Specifies the maximum number of characters that the method displays for object values. The default is 1000. is less than zero. is less than or equal to zero.

Displays information about the web server environment that hosts the current web page.

Displays information about the web server environment.

A string of name-value pairs that contains information about the web server.

Specifies the direction in which to sort a list of items.

Sort from smallest to largest —for example, from 1 to 10.

Sort from largest to smallest — for example, from 10 to 1.

Provides a cache to store frequently accessed data.

Retrieves the specified item from the object.

The item retrieved from the cache, or null if the item is not found. The identifier for the cache item to retrieve.

Removes the specified item from the object.

The item removed from the object. If the item is not found, returns null. The identifier for the cache item to remove.

Inserts an item into the object.

The identifier for the cache item. The data to insert into the cache. Optional. The number of minutes to keep an item in the cache. The default is 20. 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 the absolute time since the item was added to the cache. The default is true. In that case, if you also use the default value for the parameter, a cached item expires 20 minutes after it was last accessed. The value of is less than or equal to zero. Sliding expiration is enabled and the value of is greater than a year.

Displays data on a web page using an HTML table element.

Initializes a new instance of the class.

The data to display. A collection that contains the names of the data columns to display. By default, this value is auto-populated according to the values in the parameter. The name of the data column that is used to sort the grid by default. The number of rows that are displayed on each page of the grid when paging is enabled. The default is 10. true to specify that paging is enabled for the instance; otherwise false. The default is true. true to specify that sorting is enabled for the instance; otherwise, false. The default is true. The value of the HTML id attribute that is used to mark the HTML element that gets dynamic Ajax updates that are associated with the instance. The name of the JavaScript function that is called after the HTML element specified by the property has been updated. If the name of a function is not provided, no function will be called. If the specified function does not exist, a JavaScript error will occur if it is invoked. The prefix that is applied to all query-string fields that are associated with the instance. This value is used in order to support multiple instances on the same web page. The name of the query-string field that is used to specify the current page of the instance. The name of the query-string field that is used to specify the currently selected row of the instance. The name of the query-string field that is used to specify the name of the data column that the instance is sorted by. The name of the query-string field that is used to specify the direction in which the instance is sorted.

Gets the name of the JavaScript function to call after the HTML element that is associated with the instance has been updated in response to an Ajax update request.

The name of the function.

Gets the value of the HTML id attribute that marks an HTML element on the web page that gets dynamic Ajax updates that are associated with the instance.

The value of the id attribute.

Binds the specified data to the instance.

The bound and populated instance. The data to display. A collection that contains the names of the data columns to bind. true to enable sorting and paging of the instance; otherwise, false. The number of rows to display on each page of the grid.

Gets a value that indicates whether the instance supports sorting.

true if the instance supports sorting; otherwise, false.

Creates a new instance.

The new column. The name of the data column to associate with the instance. The text that is rendered in the header of the HTML table column that is associated with the instance. The function that is used to format the data values that are associated with the instance. A string that specifies the name of the CSS class that is used to style the HTML table cells that are associated with the instance. true to enable sorting in the instance by the data values that are associated with the instance; otherwise, false. The default is true.

Gets a collection that contains the name of each data column that is bound to the instance.

The collection of data column names.

Returns an array that contains the specified instances.

An array of columns. A variable number of column instances.

Gets the prefix that is applied to all query-string fields that are associated with the instance.

The query-string field prefix of the instance.

Returns a JavaScript statement that can be used to update the HTML element that is associated with the instance on the specified web page.

A JavaScript statement that can be used to update the HTML element in a web page that is associated with the instance. The URL of the web page that contains the instance that is being updated. The URL can include query-string arguments.

Returns the HTML markup that is used to render the instance and using the specified paging options.

The HTML markup that represents the fully-populated instance. The name of the CSS class that is used to style the whole table. The name of the CSS class that is used to style the table header. The name of the CSS class that is used to style the table footer. The name of the CSS class that is used to style each table row. The name of the CSS class that is used to style even-numbered table rows. The name of the CSS class that is used to style the selected table row. (Only one row can be selected at a time.) The table caption. true to display the table header; otherwise, false. The default is true. true to insert additional rows in the last page when there are insufficient data items to fill the last page; otherwise, false. The default is false. Additional rows are populated using the text specified by the parameter. The text that is used to populate additional rows in a page when there are insufficient data items to fill the last page. The parameter must be set to true to display these additional rows. A collection of instances that specify how each column is displayed. This includes which data column is associated with each grid column, and how to format the data values that each grid column contains. A collection that contains the names of the data columns to exclude when the grid auto-populates columns. A bitwise combination of the enumeration values that specify methods that are provided for moving between pages of the instance. The text for the HTML link element that is used to link to the first page of the instance. The flag of the parameter must be set to display this page navigation element. The text for the HTML link element that is used to link to previous page of the instance. The flag of the parameter must be set to display this page navigation element. The text for the HTML link element that is used to link to the next page of the instance. The flag of the parameter must be set to display this page navigation element. The text for the HTML link element that is used to link to the last page of the instance. The flag of the parameter must be set to display this page navigation element. The number of numeric page links that are provided to nearby pages. The text of each numeric page link contains the page number. The flag of the parameter must be set to display these page navigation elements. An object that represents a collection of attributes (names and values) to set for the HTML table element that represents the instance.

Returns a URL that can be used to display the specified data page of the instance.

A URL that can be used to display the specified data page of the grid. The index of the page to display.

Returns a URL that can be used to sort the instance by the specified column.

A URL that can be used to sort the grid. The name of the data column to sort by.

Gets a value that indicates whether a row in the instance is selected.

true if a row is currently selected; otherwise, false.

Returns a value that indicates whether the instance can use Ajax calls to refresh the display.

true if the instance supports Ajax calls; otherwise, false..

Gets the number of pages that the instance contains.

The page count.

Gets the full name of the query-string field that is used to specify the current page of the instance.

The full name of the query string field that is used to specify the current page of the grid.

Gets or sets the index of the current page of the instance.

The index of the current page. The property cannot be set because paging is not enabled.

Returns the HTML markup that is used to provide the specified paging support for the instance.

The HTML markup that provides paging support for the grid. A bitwise combination of the enumeration values that specify the methods that are provided for moving between the pages of the grid. The default is the bitwise OR of the and flags. The text for the HTML link element that navigates to the first page of the grid. The text for the HTML link element that navigates to the previous page of the grid. The text for the HTML link element that navigates to the next page of the grid. The text for the HTML link element that navigates to the last page of the grid. The number of numeric page links to display. The default is 5.

Gets a list that contains the rows that are on the current page of the instance after the grid has been sorted.

The list of rows.

Gets the number of rows that are displayed on each page of the instance.

The number of rows that are displayed on each page of the grid.

Gets or sets the index of the selected row relative to the current page of the instance.

The index of the selected row relative to the current page.

Gets the currently selected row of the instance.

The currently selected row.

Gets the full name of the query-string field that is used to specify the selected row of the instance.

The full name of the query string field that is used to specify the selected row of the grid.

Gets or sets the name of the data column that the instance is sorted by.

The name of the data column that is used to sort the grid.

Gets or sets the direction in which the instance is sorted.

The sort direction.

Gets the full name of the query-string field that is used to specify the sort direction of the instance.

The full name of the query string field that is used to specify the sort direction of the grid.

Gets the full name of the query-string field that is used to specify the name of the data column that the instance is sorted by.

The full name of the query-string field that is used to specify the name of the data column that the grid is sorted by.

Returns the HTML markup that is used to render the instance.

The HTML markup that represents the fully-populated instance. The name of the CSS class that is used to style the whole table. The name of the CSS class that is used to style the table header. The name of the CSS class that is used to style the table footer. The name of the CSS class that is used to style each table row. The name of the CSS class that is used to style even-numbered table rows. The name of the CSS class that is used use to style the selected table row. The table caption. true to display the table header; otherwise, false. The default is true. true to insert additional rows in the last page when there are insufficient data items to fill the last page; otherwise, false. The default is false. Additional rows are populated using the text specified by the parameter. The text that is used to populate additional rows in the last page when there are insufficient data items to fill the last page. The parameter must be set to true to display these additional rows. A collection of instances that specify how each column is displayed. This includes which data column is associated with each grid column, and how to format the data values that each grid column contains. A collection that contains the names of the data columns to exclude when the grid auto-populates columns. A function that returns the HTML markup that is used to render the table footer. An object that represents a collection of attributes (names and values) to set for the HTML table element that represents the instance.

Gets the total number of rows that the instance contains.

The total number of rows in the grid. This value includes all rows from every page, but does not include the additional rows inserted in the last page when there are insufficient data items to fill the last page.

Represents a column in a instance.

Initializes a new instance of the class.

Gets or sets a value that indicates whether the column can be sorted.

true to indicate that the column can be sorted; otherwise, false.

Gets or sets the name of the data item that is associated with the column.

The name of the data item.

Gets or sets a function that is used to format the data item that is associated with the column.

The function that is used to format that data item that is associated with the column.

Gets or sets the text that is rendered in the header of the column.

The text that is rendered to the column header.

Gets or sets the CSS class attribute that is rendered as part of the HTML table cells that are associated with the column.

The CSS class attribute that is applied to cells that are associated with the column.

Specifies flags that describe the methods that are provided for moving between the pages of a instance.

Indicates that methods for moving to a nearby page by using a page number are provided.

Indicates that methods for moving to the next or previous page are provided.

Indicates that methods for moving directly to the first or last page are provided.

Indicates that all methods for moving between pages are provided.

Represents a row in a instance.

Initializes a new instance of the class using the specified instance, row value, and index.

The instance that contains the row. An object that contains a property member for each value in the row. The index of the row.

Returns an enumerator that can be used to iterate through the values of the instance.

An enumerator that can be used to iterate through the values of the row.

Returns an HTML element (a link) that users can use to select the row.

The link that users can click to select the row. The inner text of the link element. If is empty or null, "Select" is used.

Returns the URL that can be used to select the row.

The URL that is used to select a row.

Returns the value at the specified index in the instance.

The value at the specified index. The zero-based index of the value in the row to return. is less than 0 or greater than or equal to the number of values in the row.

Returns the value that has the specified name in the instance.

The specified value. The name of the value in the row to return. is null or empty. specifies a value that does not exist.

Returns an enumerator that can be used to iterate through a collection.

An enumerator that can be used to iterate through the collection.

Returns a string that represents all of the values of the instance.

A string that represents the row's values.

Returns the value of a member that is described by the specified binder.

true if the value of the item was successfully retrieved; otherwise, false. The getter of the bound property member. When this method returns, contains an object that holds the value of the item described by . This parameter is passed uninitialized.

Gets an object that contains a property member for each value in the row.

An object that contains each value in the row as a property.

Gets the instance that the row belongs to.

The instance that contains the row.

Represents an object that lets you display and manage images in a web page.

Initializes a new instance of the class using a byte array to represent the image.

The image.

Initializes a new instance of the class using a stream to represent the image.

The image.

Initializes a new instance of the class using a path to represent the image location.

The path of the file that contains the image.

Adds a watermark image using a path to the watermark image.

The watermarked image. The path of a file that contains the watermark image. The width, in pixels, of the watermark image. The height, in pixels, of the watermark image. The horizontal alignment for watermark image. Values can be "Left", "Right", or "Center". The vertical alignment for the watermark image. Values can be "Top", "Middle", or "Bottom". The opacity for the watermark image, specified as a value between 0 and 100. The size, in pixels, of the padding around the watermark image.

Adds a watermark image using the specified image object.

The watermarked image. A object. The width, in pixels, of the watermark image. The height, in pixels, of the watermark image. The horizontal alignment for watermark image. Values can be "Left", "Right", or "Center". The vertical alignment for the watermark image. Values can be "Top", "Middle", or "Bottom". The opacity for the watermark image, specified as a value between 0 and 100. The size, in pixels, of the padding around the watermark image.

Adds watermark text to the image.

The watermarked image. The text to use as a watermark. The color of the watermark text. The font size of the watermark text. The font style of the watermark text. The font type of the watermark text. The horizontal alignment for watermark text. Values can be "Left", "Right", or "Center". The vertical alignment for the watermark text. Values can be "Top", "Middle", or "Bottom". The opacity for the watermark image, specified as a value between 0 and 100. The size, in pixels, of the padding around the watermark text.

Copies the object.

The image.

Crops an image.

The cropped image. The number of pixels to remove from the top. The number of pixels to remove from the left. The number of pixels to remove from the bottom. The number of pixels to remove from the right.

Gets or sets the file name of the object.

The file name.

Flips an image horizontally.

The flipped image.

Flips an image vertically.

The flipped image.

Returns the image as a byte array.

The image. The value of the object.

Returns an image that has been uploaded using the browser.

The image. (Optional) The name of the file that has been posted. If no file name is specified, the first file that was uploaded is returned.

Gets the height, in pixels, of the image.

The height.

Gets the format of the image (for example, "jpeg" or "png").

The file format of the image.

Resizes an image.

The resized image. The width, in pixels, of the object. The height, in pixels, of the object. true to preserve the aspect ratio of the image; otherwise, false. true to prevent the enlargement of the image; otherwise, false.

Rotates an image to the left.

The rotated image.

Rotates an image to the right.

The rotated image.

Saves the image using the specified file name.

The image. The path to save the image to. The format to use when the image file is saved, such as "gif", or "png". true to force the correct file-name extension to be used for the format that is specified in ; otherwise, false. If there is a mismatch between the file type and the specified file-name extension, and if is true, the correct extension will be appended to the file name. For example, a PNG file named Photograph.txt is saved using the name Photograph.txt.png.

Gets the width, in pixels, of the image.

The width.

Renders an image to the browser.

The image. (Optional) The file format to use when the image is written.

Provides a way to construct and send an email message using Simple Mail Transfer Protocol (SMTP).

Gets or sets a value that indicates whether Secure Sockets Layer (SSL) is used to encrypt the connection when an email message is sent.

true if SSL is used to encrypt the connection; otherwise, false.

Gets or sets the email address of the sender.

The email address of the sender.

Gets or sets the password of the sender's email account.

The sender's password.

Sends the specified message to an SMTP server for delivery.

The email address of the recipient or recipients. Separate multiple recipients using a semicolon (;). The subject line for the email message. The body of the email message. If is true, HTML in the body is interpreted as markup. (Optional) The email address of the message sender, or null to not specify a sender. The default value is null. (Optional) The email addresses of additional recipients to send a copy of the message to, or null if there are no additional recipients. Separate multiple recipients using a semicolon (;). The default value is null. (Optional) A collection of file names that specifies the files to attach to the email message, or null if there are no files to attach. The default value is null. (Optional) true to specify that the email message body is in HTML format; false to indicate that the body is in plain-text format. The default value is true. (Optional) A collection of headers to add to the normal SMTP headers included in this email message, or null to send no additional headers. The default value is null. (Optional) The email addresses of additional recipients to send a "blind" copy of the message to, or null if there are no additional recipients. Separate multiple recipients using a semicolon (;). The default value is null. (Optional) The encoding to use for the body of the message. Possible values are property values for the class, such as . The default value is null. (Optional) The encoding to use for the header of the message. Possible values are property values for the class, such as . The default value is null. (Optional) A value ("Normal", "Low", "High") that specifies the priority of the message. The default is "Normal". (Optional) The email address that will be used when the recipient replies to the message. The default value is null, which indicates that the reply address is the value of the From property.

Gets or sets the port that is used for SMTP transactions.

The port that is used for SMTP transactions.

Gets or sets the name of the SMTP server that is used to transmit the email message.

The SMTP server.

Gets or sets a value that indicates whether the default credentials are sent with the requests.

true if credentials are sent with the email message; otherwise, false.

Gets or sets the name of email account that is used to send email.

The name of the user account.