Partager via


ScriptableMemberAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Indicates that a specific property, method, or event is accessible to JavaScript callers.

Inheritance Hierarchy

System.Object
  System.Attribute
    System.Windows.Browser.ScriptableMemberAttribute

Namespace:  System.Windows.Browser
Assembly:  System.Windows.Browser (in System.Windows.Browser.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Event, AllowMultiple := False,  _
    Inherited := True)> _
Public NotInheritable Class ScriptableMemberAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Event, AllowMultiple = false, 
    Inherited = true)]
public sealed class ScriptableMemberAttribute : Attribute

The ScriptableMemberAttribute type exposes the following members.

Constructors

  Name Description
Public method ScriptableMemberAttribute Initializes a new instance of the ScriptableMemberAttribute class.

Top

Properties

  Name Description
Public property EnableCreateableTypes Controls the generation of Silverlight plug-in helper methods that can be used to create wrappers around managed objects.
Public property ScriptAlias Gets or sets the name of a property, method, or event that is exposed to JavaScript code. By default, the script alias is the same as the name of the managed property, method, or event.

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

If you want to expose all properties, methods, and events that are associated with a type as scriptable, use the ScriptableTypeAttribute class instead.

Examples

The following example shows how you make a property, method, or event (PME) scriptable by applying the ScriptableMemberAttribute immediately before the name of the PME.

public class SMT_ScriptableManagedType
    {
    [ScriptableMember]         // This is the preferred syntax
     public string GetString()
        { return "abcdefg"; }

    [ScriptableMemberAttribute]  // This is also acceptable
     public string GetString()
        { return "abcdefg"; }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.