WebMethodAttribute

Wisej.Core.WebMethodAttribute

Namespace: Wisej.Core

Assembly: Wisej.Framework (4.0.0.0)

Indicates that the method can be called from the browser using JavaScript.

C#

public class WebMethodAttribute : Attribute

VB.NET

Public Class WebMethodAttribute
    Inherits Attribute

You can add this attribute to static methods in your Wisej application Program class and to instance methods in top level containers: Page, Form, and Desktop. If you want to register web methods on child controls, you can, but Wisej only searches top level containers automatically. To register web methods on a child control, extend the control class, override OnWebRender and call RegisterWebMethods.

public class MyButton : Button
{
  protected override void OnWebRender(dynamic config)
  {
    base.OnWebRender((object)config);
    RegisterWebMethods(config);
  }
}

Default parameters are not supported in Web Methods. This is supported:

[WebMethod]
public void myWebMethod(string s)

But this is not supported:

[WebMethod]
public void myWebMethod(string s = "default value")

Constructors

WebMethodAttribute()

Initializes the WebMethodAttribute attribute.

WebMethodAttribute(inheritable)

Initializes the WebMethodAttribute attribute.

Name	Type	Description
inheritable	Boolean	Indicates whether the web method is inherited by derived classes.

Properties

Inheritable

Boolean: Returns a value indicating whether the web method is inherited by derived classes.

Methods

GetMethod(type, name, parametersCount)

Returns the request web method.

Parameter	Type	Description
type	Type	The type to search to the web method name .
name	String	Name of the web method to find.
parametersCount	Int32	Number of parameters of the web method to find.

Returns: MethodInfo. The MethodInfo for the specified method or null.

GetMethod(component, name, parametersCount)

Returns the request web method.

Parameter	Type	Description
component	IWisejComponent	The IWisejComponent defining the web methods.
name	String	Name of the web method to find.
parametersCount	Int32	Number of parameters of the web method to find.

Returns: MethodInfo. The MethodInfo for the specified method.

GetMethod(type, shared, name, parametersCount)

Returns the request web method.

Parameter	Type	Description
type	Type	The type to search to the web method name .
shared	Boolean	True to check only the static/shared web methods declared in type .
name	String	Name of the web method to find.
parametersCount	Int32	Number of parameters of the web method to find.

Returns: MethodInfo. The MethodInfo for the specified method or null.

GetMethods(type)

Returns the static web methods.

Parameter	Type	Description
type	Type	The type defining the web methods.

Returns: List<String>. List of web methods.

GetMethods(component)

Returns the instance web methods on the object. '

Parameter	Type	Description
component	IWisejComponent	The IWisejComponent defining the web methods.

Returns: List<String>. List of web methods.

GetMethods(type, declaredOnly, shared)

Returns the registered web methods on the object.

Parameter	Type	Description
type	Type	The type defining the web methods.
declaredOnly	Boolean	True to enumerate the web methods declared in type ignoring inherited methods.
shared	Boolean	True to enumerate the static/shared web methods declared in type .

Returns: List<String>. List of web methods.

IsWebMethod(method, targetType)

Checks if the specified method can be called as a web method.

Parameter	Type	Description
method	MethodInfo	The MethodInfo descriptor.
targetType	Type	Target type for the method call.

Returns: Boolean.