Método IVsPropertyPage.CategoryTitle (UInt32, String)

Artigo
04/23/2016

Retorna a categoria na qual suas páginas de propriedade devem ser exibidas no modo de exibição de árvore.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int CategoryTitle(
    uint iLevel,
    out string pbstrCategory
)

int CategoryTitle(
    unsigned int iLevel,
    [OutAttribute] String^% pbstrCategory
)

abstract CategoryTitle : 
        iLevel:uint32 *
        pbstrCategory:string byref -> int

Function CategoryTitle (
    iLevel As UInteger,
    <OutAttribute> ByRef pbstrCategory As String
) As Integer

Parâmetros

iLevel
[in] Integer contendo o nível.

pbstrCategory
[out, retval] Ponteiro para a categoria (pasta) sob a qual você deseja que sua página de propriedades a serem exibidos.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsPropertyPage::CategoryTitle(
   [in]UINT iLevel,
   [out, retval]BSTR *pbstrCategory
);

Se sua página de propriedades não tem uma categoria e preferi-la para mostrar no nível superior da exibição em árvore diretamente sob a categoria de nível superior apropriada, qualquer um pode implementar IPropertyPage sozinhas ou retorno E_NOTIMPL deste método.

Caso contrário, o ambiente primeiro chama esse método com um iLevel o valor zero.
Em seguida, você pode retornar o nome da categoria que deve ser o mais próximo ancestral direto desta página na árvore.
O ambiente, em seguida, chame você com um iLevel valor de um.
Se você quiser que a página ser recuadas um nível, em seguida, retorne S_FALSE.
O ambiente continua a chamar este método, aumentando o valor do iLevel por um cada vez, até retornar algo diferente de S_OK, ou alcançar o limite interno do ambiente de que ele aceita.

Retornando E_NOTIMPL e S_FALSE pára de processamento sem mostrar um erro ao usuário.Qualquer outro valor diferente de S_OK pode fazer com que as informações de erro a ser mostrado ao usuário.

Atualmente o ambiente suporta apenas dois níveis de categorias:

CatLevel1

CatLevel0

PageName

As categorias de Visual Studio, propriedades comuns e propriedades de configuração, estão acima de CatLevel1 na hierarquia.As categorias de Visual Studio não contam como parte dos dois níveis.Você não retorne-as da get_CategoryTitle.

Consulte também

Interface IVsPropertyPage
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via