TextViewOptionExtensions.DoesViewProhibitUserInput Method

Determines whether the view prohibits all user input.

Namespace:  Microsoft.VisualStudio.Text.Editor.OptionsExtensionMethods
Assembly:  Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function DoesViewProhibitUserInput ( _
    options As IEditorOptions _
) As Boolean

public static bool DoesViewProhibitUserInput(
    this IEditorOptions options
)

[ExtensionAttribute]
public:
static bool DoesViewProhibitUserInput(
    IEditorOptions^ options
)

static member DoesViewProhibitUserInput : 
        options:IEditorOptions -> bool

public static function DoesViewProhibitUserInput(
    options : IEditorOptions
) : boolean

Parameters

• options
  Type: Microsoft.VisualStudio.Text.Editor.IEditorOptions

  The set of editor options.

Return Value

Type: System.Boolean
true if all user input to the view is prohibited, otherwise false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEditorOptions. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The view's underlying buffer can still be modified even if this option is set.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

TextViewOptionExtensions Class

Microsoft.VisualStudio.Text.Editor.OptionsExtensionMethods Namespace