IVsSplitter.SplitPane Method

Article
03/11/2013

Splits the indicated pane of this splitter.

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

Syntax

'Declaration
Function SplitPane ( _
    pNewPane As IVsSplitPane, _
    iIndex As Integer, _
    iSize As Integer, _
    dwFlags As UInteger, _
    <OutAttribute> ByRef ppSplitter As IVsSplitter _
) As Integer

int SplitPane(
    IVsSplitPane pNewPane,
    int iIndex,
    int iSize,
    uint dwFlags,
    out IVsSplitter ppSplitter
)

int SplitPane(
    [InAttribute] IVsSplitPane^ pNewPane, 
    [InAttribute] int iIndex, 
    [InAttribute] int iSize, 
    [InAttribute] unsigned int dwFlags, 
    [OutAttribute] IVsSplitter^% ppSplitter
)

abstract SplitPane : 
        pNewPane:IVsSplitPane * 
        iIndex:int * 
        iSize:int * 
        dwFlags:uint32 * 
        ppSplitter:IVsSplitter byref -> int

function SplitPane(
    pNewPane : IVsSplitPane, 
    iIndex : int, 
    iSize : int, 
    dwFlags : uint, 
    ppSplitter : IVsSplitter
) : int

Parameters

pNewPane
Type: Microsoft.VisualStudio.TextManager.Interop.IVsSplitPane
[in] The IVsSplitPane of the new pane.

iIndex
Type: System.Int32
[in] The index of the pane.

iSize
Type: System.Int32
[in] The size of the pane.

dwFlags
Type: System.UInt32
[in] The flags.

ppSplitter
Type: Microsoft.VisualStudio.TextManager.Interop.IVsSplitter%
[out] The IVsSplitter.

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 IVsSplitter::SplitPane(
   [in] IVsSplitPane *pNewPane,
   [in] long iIndex,
   [in] long iSize,
   [in] DWORD dwFlags,
   [out] IVsSplitter **ppSplitter
);

The provided pane can become either the primary or secondary pane of the newly created splitter pane, which replaces the indicated pane. The iSize parameter refers to the size of the new pane, regardless of if it is becoming the primary or secondary pane.

.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.

Share via