ResourceExpressionEditorSheet Class

Definition

Represents a design-time editor sheet for the properties of a resource expression in the UI of a designer host at design time.

public ref class ResourceExpressionEditorSheet : System::Web::UI::Design::ExpressionEditorSheet
public class ResourceExpressionEditorSheet : System.Web.UI.Design.ExpressionEditorSheet
type ResourceExpressionEditorSheet = class
    inherit ExpressionEditorSheet
Public Class ResourceExpressionEditorSheet
Inherits ExpressionEditorSheet
Inheritance
ResourceExpressionEditorSheet

Examples

The following code example demonstrates how to bind the Text property of a HyperLink control to a resource expression using the ResourceExpressionEditor. To use the example:

  1. In a Web site project, add a new resource file named Strings.resx to the App_GlobalResources folder.

  2. Add a string named myLinkText to the Strings.resx resource file, and set the value to the text for a HyperLink control. For example, set the myLinkText string value to This is a link.

  3. In an ASP.NET Web page, add a HyperLink control.

  4. In the property grid for the Hyperlink control, click Expressions, and click the ellipsis button (...) to display the expression binding dialog box.

  5. Select the Text property of a control, and set Expression Type to the Resources expression type. The visual designer displays the resource expression properties defined by the ResourceExpressionEditorSheet object.

  6. Set the Expression Properties as follows:

    • Set ClassKey to Strings, the class name for the compiled Strings.resx resource file.

    • Set ResourceKey to myLinkText, the string name in Strings.resx.

The visual designer uses the ResourceExpressionEditor object to assign the resource expression for the Text property. The following aspx source shows an example of a property value set using a resource expression:

<!-- Define a hyperlink that maps the Text property to the
     myLinkText string value in the Strings.resx resource file. -->
<asp:HyperLink runat="server" ID="HyperLink2" 
     Text="<%$ Resources:Strings, myLinkText %>"
     NavigateUrl="http://www.microsoft.com"></asp:HyperLink>
<!-- Define a hyperlink that maps the Text property to the
     myLinkText string value in the Strings.resx resource file. -->
<asp:HyperLink runat="server" ID="HyperLink2" 
     Text="<%$ Resources:Strings, myLinkText%>"
     NavigateUrl="http://www.microsoft.com"></asp:HyperLink>
<FileName>ControlsUsingExpressions.aspx</FileName>
<RelevantItems>
    <Reference>System.Web.UI.Design.ResourceExpressionEditor</Reference>
</RelevantItems>

Remarks

The visual designer uses the ResourceExpressionEditor class with the ResourceExpressionEditorSheet class to select the individual properties of a resource reference expression, and to combine the selected resource expression property values into a resource expression.

The ConnectionStringsExpressionEditor.GetExpressionEditorSheet method returns a ResourceExpressionEditorSheet object. In the expressions dialog box, when you select a control property and bind it to a resource expression, the visual designer calls the GetExpressionEditorSheet method. The visual designer uses the returned ResourceExpressionEditorSheet object to prompt for the ClassKey and ResourceKey properties. Once the resource expression properties are selected, the visual designer calls the GetExpression method to combine the properties into a resource expression string.

The ResourceKey property must be specified in a resource expression; it indexes the resource value. The ClassKey property is optional. It references the class key or file name that defines the resource in the global resources folder.

Constructors

ResourceExpressionEditorSheet(String, IServiceProvider)

Initializes a new instance of the ResourceExpressionEditorSheet class.

Properties

ClassKey

Gets or sets the key that matches the filename for the resource in the project's global resource folder.

IsValid

Gets a value that indicates whether the resource expression string is valid.

ResourceKey

Gets or sets the name of the resource, which is used as a key to find the resource value.

ServiceProvider

Gets the service provider implementation that is used by the expression editor sheet.

(Inherited from ExpressionEditorSheet)

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetExpression()

Returns a resource expression that is formed by the expression editor sheet property values.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also