IVsTextHidingLayerModule.MakeBaseSpanVisible(TextSpan[]) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Makes a text span visible.

public:
 int MakeBaseSpanVisible(cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pBaseSpan);

public:
 int MakeBaseSpanVisible(Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pBaseSpan);

int MakeBaseSpanVisible(std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & pBaseSpan);

public int MakeBaseSpanVisible (Microsoft.VisualStudio.TextManager.Interop.TextSpan[] pBaseSpan);

abstract member MakeBaseSpanVisible : Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int

Public Function MakeBaseSpanVisible (pBaseSpan As TextSpan()) As Integer

Parameters

pBaseSpan

TextSpan[]

Make EVERY CHARACTER of the span visible.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.S_OK: the span was hidden but is now visibleS_FALSE: the span wasn't hidden by this layerE_FAIL: the span is hidden but the layer doesn't know how to unhide it (will result in the layer being destroyed)

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextHidingLayerModule::MakeBaseSpanVisible(  
   TextSpan *pBaseSpan  
);  

The pBaseSpan parameter indicates that all of the base text therein must be made visible. For example, if there is hidden text in the middle of a line and the start and end of the line is passed in pBaseSpan to MakeBaseSpanVisible, this is not sufficient to ensure that only the start and end of the line are visible; every character in the span must be visible.

In some cases (for example, highlighting a find hit) you want to use this on a span of text. In others (for example, the "Go To Line" command), you only want to ensure that the beginning of the physical line is visible, but you don't want to force the entire contents of the physical line to be revealed.

The required side effect of this function succeeding is that a call to BaseLineIndexToLocal on any character within *pBaseSpan must succeed and not return VIEW_E_LOCATION_HIDDEN.