IVsCompletionSet.GetInitialExtent Method

Determines where to display the completion set list in the editor.

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Déclaration
Function GetInitialExtent ( _
    <OutAttribute> ByRef piLine As Integer, _
    <OutAttribute> ByRef piStartCol As Integer, _
    <OutAttribute> ByRef piEndCol As Integer _
) As Integer
'Utilisation
Dim instance As IVsCompletionSet
Dim piLine As Integer
Dim piStartCol As Integer
Dim piEndCol As Integer
Dim returnValue As Integer

returnValue = instance.GetInitialExtent(piLine, _
    piStartCol, piEndCol)
int GetInitialExtent(
    out int piLine,
    out int piStartCol,
    out int piEndCol
)
int GetInitialExtent(
    [OutAttribute] int% piLine, 
    [OutAttribute] int% piStartCol, 
    [OutAttribute] int% piEndCol
)
abstract GetInitialExtent : 
        piLine:int byref * 
        piStartCol:int byref * 
        piEndCol:int byref -> int 
function GetInitialExtent(
    piLine : int, 
    piStartCol : int, 
    piEndCol : int
) : int

Parameters

  • piLine
    Type: System.Int32%
    [out] Returns the line number of the characters that should not be obscured.
  • piStartCol
    Type: System.Int32%
    [out] Returns the column number of the first character that should not be obscured.
  • piEndCol
    Type: System.Int32%
    [out] Returns the last character in the span that should not be obscured. This must be on the same line as piLine.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsCompletionSet::GetInitialExtent(
   [out] long *piLine,
   [out] long *piStartCol,
   [out] long *piEndCol
);

Use this method to tell the view where to place the completion box. By specifying values for piLine, piCol and piLen, you are indicating a span of text that the view should not obscure with the completion box. If the value of the piLen parameter is set to zero, then an anchor coordinate (piCol, piLine) must be provided.

.NET Framework Security

See Also

Reference

IVsCompletionSet Interface

IVsCompletionSet Members

Microsoft.VisualStudio.TextManager.Interop Namespace