_BufferCoordinatorMappingMode Enum

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Specifies the buffer coordinator mapping mode for contained languages.

public enum class _BufferCoordinatorMappingMode

public enum class _BufferCoordinatorMappingMode

enum _BufferCoordinatorMappingMode

public enum _BufferCoordinatorMappingMode

type _BufferCoordinatorMappingMode = 

Public Enum _BufferCoordinatorMappingMode

Inheritance

Enum

_BufferCoordinatorMappingMode

Fields

Name	Value	Description
BCMM_NORMAL	0	Indicates the default mode, in which the primary span equals the secondary span.
BCMM_EXTENDEDRIGHT	1	Indicates that the primary span actually has an additional character at the end, but only the characters before that additional character are replicated to the secondary span. This mode is used to prevent deletion of text markers when one of the spans collapses into 0 characters, for example, when the user deletes everything in the span range. In extended right mode, the primary span includes the '<' from the closing </script> tag. Normally this mode should be changed only when there are no mappings. If the mapping mode is changed when the buffer coordinator already has span mappings, the result is unpredictable.
BCMM_EXTENDEDLEFT	2	Indicates that the primary span actually has an additional character at the beginning, but only the characters after that additional character are replicated to the secondary span. This mode is used to prevent deletion of text markers when one of the spans collapses into 0 characters, for example, when the user deletes everything in the span range. In the extended left mode, the primary span includes the '>' from the opening <script>tag. Normally this mode should be changed only when there are no mappings. If the mapping mode is changed when the buffer coordinator already has span mappings, the result is unpredictable.
BCMM_EXTENDED	3	A combination of BCMM_EXTENDEDLEFT and BCMM_EXTENDEDRIGHT.
BCMM_ENTIREBUFFER	4	Indicates that the buffer is a single span, so no markers are required. This is a special mode; if you create a marker to track the entire buffer, the marker will be deleted when the user deletes the contents of the entire buffer, and all subsequent marker events are lost. There is no way to create a marker that is wider than the buffer. This mode supersedes any other bit flags set.

Remarks

COM Signature

From singlefileeditor.idl:

enum _BufferCoordinatorMappingMode {  
    BCMM_NORMAL        = 0,   
    BCMM_EXTENDEDLEFT  = 0x2,  
    BCMM_EXTENDEDRIGHT = 0x1,  
    BCMM_EXTENDED      = 0x3,  
    BCMM_ENTIREBUFFER  = 0x4   
};  
typedef DWORD BufferCoordinatorMappingMode;  

The values in this enumeration are passed to the SetBufferMappingModes method in the IVsTextBufferCoordinator interface.