JSObject.GetPropertyAsBoolean(String) Method

Definition

Returns the value of the specified property as Boolean if the property exists, otherwise false.

public:
 bool GetPropertyAsBoolean(System::String ^ propertyName);
public bool GetPropertyAsBoolean (string propertyName);
member this.GetPropertyAsBoolean : string -> bool
Public Function GetPropertyAsBoolean (propertyName As String) As Boolean

Parameters

propertyName
String

The name of the property.

Returns

The value of the property with the specified name.

Exceptions

The property value is not a Boolean.

Remarks

This method throws a JSException when the property value is not a Boolean.

Applies to