IReadOnlyRegionEdit::CreateReadOnlyRegion Method (Span, SpanTrackingMode, EdgeInsertionMode)

Visual Studio 2015

Marks a span of text in this buffer as read-only. The span remains read-only until it is marked as writable or forced writable again.

Namespace: Microsoft.VisualStudio.Text
Assembly: Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

C++

IReadOnlyRegion^ CreateReadOnlyRegion(
	Span span,
	SpanTrackingMode trackingMode,
	EdgeInsertionMode edgeInsertionMode
)

Parameters

span: Type: Microsoft.VisualStudio.Text::Span
The span to mark as read-only.

trackingMode: Type: Microsoft.VisualStudio.Text::SpanTrackingMode
Specifies the tracking behavior of the read-only region.

edgeInsertionMode: Type: Microsoft.VisualStudio.Text::EdgeInsertionMode
Specifies the edge insertion behavior of the read-only region.

Return Value

Type: Microsoft.VisualStudio.Text::IReadOnlyRegion^

The IReadOnlyRegion used to track this read-only region. This object will be used to remove the read-only region.

Exceptions

Exception	Condition
ArgumentNullException	span is null.
ArgumentOutOfRangeException	span is past the end of the buffer.

Remarks

Zero-length read-only regions restrict inserts only at the exact point defined by the region. A deletion or modification that includes that point can still occur.