Método ActivateWizard

Reinicia ou suspende uma sessão do Assistente do Office.

Observação   Este método é usado como parte do processo iniciado com o método StartWizard.

Sintaxe

expressão.ActivateWizard(WizardID, Act, Animation)

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.

WizardID   Long obrigatório. Um número que identifica exclusivamente a sessão do Assistente do Office, conforme retornado pelo método StartWizard.

Act   Variant obrigatória. Especifica a maneira como a sessão do Assistente do Office é alterada. Pode ser uma das seguintes constantes msoWizardActTypes: msoWizardActActive, msoWizardActInactive, msoWizardActResume ou msoWizardActSuspend.

Animation   Variant opcional. O tipo de animação que o Assistente do Office efetua ao reiniciar ou suspender a sessão de assistente.


Exemplo do método ActivateWizard

Este exemplo suspende a sessão de Assistente do Office iniciada pelo método StartWizard. A variável helpForWiz foi definida com o valor retornado pelo método StartWizard.

Assistant.ActivateWizard WizardID:=helpForWiz, _

   Act:=msoWizardActSuspend, Animation:=msoAnimationGoodbye


Método Close

Fecha o balão não modal ativo.

Sintaxe

expressão.Close

expressão   Obrigatória. Uma expressão que retorne um objeto Balloon.


Exemplo do método Close

Este exemplo exibe um balão contendo instruções para escolha de uma impressora. Após o usuário clicar no botão OK do balão, o procedimento ProcessPrinter é executado e o balão é fechado.

Sub shar()

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    .Labels(1).Text = "Choose File, Print."

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With

End Sub

Sub ProcessPrinter(bln As Balloon, ibtn As Long, _

 iPriv As Long)

    Assistant.Animation = msoAnimationSearching

     ' Insert printer-specific code

    bln.Close

End Sub


Método EndWizard

Fecha a janela do Assistente do Office e libera a variável que identifica exclusivamente a sessão do assistente.

Observação   Você usa esse método para completar o processo iniciado pelo método StartWizard.

Sintaxe

expressão.EndWizard(WizardID, varfSuccess, Animation)

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.

WizardID   Long obrigatório. Um número que identifica exclusivamente a sessão do Assistente do Office, conforme retornado pelo método StartWizard.

varfSuccess   Boolean obrigatório. Quando o método retorna, esse argumento é True se o usuário completou o assistente com êxito.

Animation   Variant opcional. O tipo de animação que o Assistente do Office efetua quando a sessão de assistente termina.


Exemplo do método EndWizard

Este exemplo fecha o Assistente do Office para uma sessão de assistente que tenha sido completada com êxito pelo usuário. À variável helpForWiz foi atribuído o valor retornado pelo método StartWizard.

Assistant.EndWizard WizardId:=helpForWiz, _

    varfSuccess:=True, Animation:=msoAnimationGoodbye


Método StartWizard

Inicia o Assistente do Office como parte de um processo para fornecer explicações adicionais para painéis de assistente personalizados existentes. Retorna um número que identifica exclusivamente a sessão do Assistente do Office.

Sintaxe

expressão.StartWizard(On, Callback, PrivateX, Animation, CustomTeaser, Top, Left, Bottom, Right)

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.

On   Boolean obrigatório. O estado local do assistente. Quando o método retorna, esse argumento é True se o usuário solicitou ajuda para o assistente a partir do balão padrão que pergunta ao usuário se ele ou ela deseja ajuda.

Callback   String obrigatória. O nome do procedimento de retorno de chamada a ser executado.

PrivateX   Long obrigatório. O identificador exclusivo do painel de balão do Assistente do Office que inicia o procedimento de retorno de chamada.

Animation   Variant opcional. O tipo de animação que o Assistente do Office efetua quando aparece. O valor padrão é msoAnimationGetWizardy.

CustomTeaser   Variant opcional. True para que o balão padrão que pergunta ao usuário se ele ou ela deseja ajuda seja substituído por um balão personalizado.

Top, Left, Bottom, Right   Variant opcional. A posição dos cantos (em pontos e em relação à tela) do painel de assistente personalizado que o Assistente do Office irá evitar quando o usuário o iniciar ou alternar para ele.

Comentários

Não é necessário usar a propriedade Visible para exibir o Assistente do Office se você usar o método StartWizard.


Exemplo do método StartWizard

Este exemplo inicia o Assistente do Office como parte de um processo para fornecer explicações adicionais para assistentes personalizados existentes. Se o usuário clicar na seleção no balão que pede ajuda adicional, o procedimento de retorno de chamada será executado. A variável helpForWiz é definida com o valor retornado pelo método StartWizard.

helpForWiz = Assistant.StartWizard(on:=True, _

    PrivateX:=23, Callback:="myCallback", _

    Animation:=msoAnimationGetAttentionMajor, _

    CustomTeaser:=False, Top:=100, Left:=200, _

    Bottom:=50, Right:=200)


Propriedade AssistWithAlerts

True se os alertas do aplicativo são veiculados pelo balão do Assistente do Office sempre que o Assistente do Office está visível. Boolean de leitura e gravação.

Comentários

A propriedade AssistWithAlerts corresponde à opção Exibir alertas sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.

Se essa propriedade for False, o aplicativo exibirá alertas em caixas de diálogo sem o Assistente do Office.


Exemplo da propriedade AssistWithAlerts

Este exemplo faz o Assistente do Office ser exibido sempre que um alerta do aplicativo for gerado.

With Assistant

    .AssistWithHelp = True

    .AssistWithAlerts = True

    .Animation = msoAnimationGreeting

    .Visible = True

End With


Propriedade AssistWithHelp

True se o Assistente do Office aparece sempre que o usuário pressiona a tecla F1 para exibir a Ajuda. Boolean de leitura e gravação.

Comentários

A propriedade AssistWithHelp corresponde à opção Responder à tecla F1 sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.

Se essa propriedade estiver definida como False, a caixa de diálogo Tópicos da Ajuda aparecerá em vez do Assistente do Office.


Exemplo da propriedade AssistWithHelp

Este exemplo exibe o Assistente do Office sempre que o usuário pressiona a tecla F1 para exibir a Ajuda.

With Assistant

    .AssistWithHelp = True

    .AssistWithAlerts = True

    .Animation = msoAnimationGreeting

    .Visible = True

End With


Propriedade Callback

Define o nome do procedimento a ser executado sempre que um balão não modal for exibido. String de leitura e gravação.

Observação   Se você especificar uma macro de uma planilha do Excel, deve incluir a planilha na referência, como em "Sheet1.myCallback" em vez de "myCallback".


Exemplo da propriedade Callback

Este exemplo exibe um balão contendo instruções para escolha de uma impressora. Após o usuário clicar no botão OK do balão, o procedimento ProcessPrinter é executado e o balão é fechado.

Sub shar()

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Select a Printer."

    .Text = "Click OK when you've selected a printer."

    .Labels(1).Text = "Network Printer"

    .Labels(2).Text = "Local Printer"

    .Labels(3).Text = "Local Color Printer"

    .BalloonType = msoBalloonTypeButtons

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With

End Sub

(São passados três argumentos para todo procedimento especificado na propriedade Callback: o balão que ativou o procedimento, o valor de retorno do botão que o usuário pressionou e um número inteiro que identifica exclusivamente o balão que chamou o procedimento.)

Sub ProcessPrinter(bln As Balloon, ibtn As Long, _

 iPriv As Long)

    Assistant.Animation = msoAnimationPrinting

    Select Case ibtn

    Case 1

        ' Insert printer-specific code

        bln.Close

    Case 2

        ' Insert printer-specific code

        bln.Close

    Case 3

        ' Insert printer-specific code

        bln.Close

    End Select

    End Sub


Propriedade Private

Retorna ou define um número inteiro que identifica exclusivamente o balão do Assistente do Office que inicia o procedimento de retorno de chamada. Long de leitura e gravação.

Comentários

Pode ser útil usar essa propriedade se você usar o mesmo procedimento de retorno de chamada em várias circunstâncias.


Exemplo da propriedade Private

Este exemplo identifica o balão do Assistente do Office definindo a propriedade Private como 129. O procedimento de retorno de chamada, myCallback, é usado em várias circunstâncias, e o número inteiro 129 será usado para identificar essa circunstância.

With myBalloon

    .Heading = "Select a region"

    .Private = 129

    .Callback = "myCallback"

    .Show

End With


Método SetAvoidRectangle

Evita que o balão do Assistente do Office seja exibido em uma área especificada da tela.

Sintaxe

expressão.SetAvoidRectangle(Left, Top, Right, Bottom)

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.

Left, Top, Right, Bottom   Long obrigatório. As coordenadas (em pontos e em relação à tela) da área da tela da qual o balão do Assistente do Office será excluído quando for exibido.

Comentários

Essa propriedade tem o objetivo de evitar que o balão do Assistente do Office sobreponha caixas de diálogo e assistentes personalizados.


Exemplo do método SetAvoidRectangle

Este exemplo evita que o balão do Assistente do Office representado pela variável myBalloon seja exibido na região da tela denotada pelas coordenadas especificadas (medidas em pixels).

With myBalloon

    .SetAvoidRectangle 300, 250, 700, 500

    .Show

End With


Método ResetTips

Redefine as dicas do aplicativo que aparecerão no balão do Assistente do Office.

Sintaxe

expressão.ResetTips

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.

Comentários

O método ResetTips corresponde ao botão Redefinir dicas da guia Opções da caixa de diálogo Assistente do Office.


Exemplo do método ResetTips

Este exemplo redefine as dicas de aplicativo antes de tornar visível o Assistente do Office. Um balão de confirmação irá aparecer, dizendo ao usuário que as suas dicas de aplicativo foram redefinidas.

With Application.Assistant

    .Visible = True

    .Animation = msoAnimationGreeting

    .ResetTips

End With


Propriedade MoveWhenInTheWay

True se a janela do Assistente do Office é movida automaticamente quando está prejudicando a visualização da área de trabalho do usuário. Por exemplo, o Assistente será movido se estiver no caminho do arrastar e soltar ou prejudicando entradas por pressionamentos de teclas. Boolean de leitura e gravação.

Comentários

A propriedade MoveWhenInTheWay corresponde à opção Mover quando prejudicar visualização sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade MoveWhenInTheWay

Este exemplo exibe o Assistente do Office em um local específico, e define várias opções antes de tornar visível o Assistente.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimGreeting

End With


Propriedade NewBalloon

Cria um novo balão do Assistente do Office. Retorna um objeto Balloon.


Exemplo da propriedade NewBalloon

Este exemplo cria um balão com um título, texto e três escolhas de região e, em seguida, o exibe.

With Assistant.NewBalloon

    .Button = msoButtonSetOK

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Propriedade Reduced

True se a janela do Assistente do Office aparece em seu tamanho menor. Boolean de leitura e gravação.


Exemplo da propriedade Reduced

Este exemplo exibe o Assistente do Office em um local específico, e define várias opções antes de tornar visível o Assistente.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


Propriedade SearchWhenProgramming

True se o Assistente do Office exibe ajuda do aplicativo bem como ajuda de programação enquanto o usuário está trabalhando no Visual Basic. Boolean de leitura e gravação.

Comentários

A propriedade SearchWhenProgramming corresponde à opção Pesquisar Ajuda de produto e programação ao programar sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade SearchWhenProgramming

Este exemplo permite que você pesquise tanto a ajuda do aplicativo quanto a ajuda de programação enquanto está trabalhando no Visual Basic.

Assistant.SearchWhenProgramming = True


Método Show

Objeto Balloon: Exibe o objeto balão especificado. Retorna uma constante msoBalloonType indicando em que balão o usuário clica.

Objeto FileFind: Exibe a caixa de diálogo Localizar arquivo e o critério de pesquisa atual. Somente Macintosh.

Syntaxe

expressão.Show

expressão   Obrigatória. Uma expressão que retorne um objeto Balloon.

Comentários

Para o objeto Balloon você pode usar o valor retornado pelo método Show para exibir a seleção de botão de um usuário. O método Show retorna uma das seguintes constantes msoBalloonType:

MsoBalloonButtonAbort MsoBalloonButtonCancel MsoBalloonButtonIgnore MsoBalloonButtonNo MsoBalloonButtonOK MsoBalloonButtonRetry MsoBalloonButtonSnooze MsoBalloonButtonYes	msoBalloonButtonBack msoBalloonButtonClose msoBalloonButtonNext msoBalloonButtonNull msoBalloonButtonOptions msoBalloonButtonSearch msoBalloonButtonTips msoBalloonButtonYesToAll


Exemplo do método Show

Este exemplo cria um balão contendo três escolhas. A variável x é definida com o valor retornado pelo método Show, o qual será 1, 2 ou 3, correspondendo ao rótulo no qual o usuário clicar. No exemplo, uma caixa de mensagem simples exibe o valor da variável x, mas você pode passar o valor para um outro procedimento, ou pode usar o valor em uma instrução Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x


Propriedade Sounds

True se o Assistente do Office produz os sons correspondentes às animações. Boolean de leitura e gravação.

Comentários

Se não houver uma placa de som instalada, essa propriedade não terá efeito algum.


Exemplo da propriedade Sounds

Este exemplo exibe o Assistente do Office, anima-o e produz som.

With Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


Propriedade TipOfDay

True se o Assistente do Office exibe uma dica especial toda vez que o aplicativo do Office é aberto. Boolean de leitura e gravação.

Comentários

A propriedade TipOfDay corresponde à opção Mostrar Dica do dia ao inicializar sob Outras opções de dica na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade TipOfDay

Este exemplo exibe o Assistente do Office em um local específico, e define várias opções antes de tornar visível o Assistente.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimGreeting

End With


Propriedade Animation

Retorna ou define a ação de animação para o Assistente do Office. Quando essa propriedade é aplicada ao objeto Assistant, o Assistente é animado imediatamente (se o Assistente estiver visível). Quando essa propriedade é aplicada ao objeto Balloon, o Assistente só é animado enquanto o balão está sendo exibido. Long de leitura e gravação.

Pode ser uma das seguintes constantes MsoAnimationType:

msoAnimationAppear msoAnimationBeginSpeaking msoAnimationCharacterSuccessMajor msoAnimationCheckingSomething msoAnimationDisappear msoAnimationEmptyTrash msoAnimationGestureDown msoAnimationGestureLeft msoAnimationGestureRight msoAnimationGestureUp msoAnimationGetArtsy msoAnimationGetAttentionMajor msoAnimationGetAttentionMinor msoAnimationGetTechy msoAnimationGetWizardy msoAnimationGoodbye msoAnimationGreeting	msoAnimationIdle msoAnimationListensToComputer msoAnimationLookDown msoAnimationLookDownLeft msoAnimationLookDownRight msoAnimationLookLeft msoAnimationLookRight msoAnimationLookUp msoAnimationLookUpLeft msoAnimationLookUpRight msoAnimationPrinting msoAnimationSaving msoAnimationSearching msoAnimationSendingMail msoAnimationThinking msoAnimationWorkingAtSomething msoAnimationWritingNotingSomething
Comentários

Clip é o Assistente padrão, e msoAnimationIdle é o tipo de animação padrão para o Assistente.

Dependendo do Assistente selecionado, a definição da propriedade Animation pode ou não resultar em alguma animação óbvia. Entretanto, todas as constantes MsoAnimationType são válidas para todos os Assistentes.

As seguintes constantes MsoAnimationType representam animações que repetem a ação especificada até o Assistente ser descartado, ou até a propriedade Animation ser redefinida com alguma outra animação.

MsoAnimationCheckingSomething msoAnimationGetArtsy msoAnimationGetTechy msoAnimationSaving	msoAnimationSearching msoAnimationThinking msoAnimationWorkingAtSomething msoAnimationWritingNotingSomething


Exemplo da propriedade Animation

Este exemplo exibe o Assistente do Office em um local específico e define suas várias opções antes de tornar visível o Assistente.

With Assistant

    .Reduced = True

    .Move xLeft:= 400, yTop:= 300

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


Propriedade FileName

Objeto Assistant: Retorna ou define o nome do arquivo do Assistente do Office ativo. String de leitura e gravação.

Objeto FileSearch: Retorna ou define o nome do arquivo a pesquisar durante uma localização de arquivo. O nome do arquivo poderá incluir os curingas * (asterisco) ou ? (ponto de interrogação). Use o curinga ponto de interrogação para corresponder a qualquer caractere único. Por exemplo, digite gr? Para corresponder tanto a "grau" como a "grua." Use o curinga asterisco para corresponder a qualquer quantidade de caracteres. Por exemplo, digite *.txt para localizar todos os arquivos que possuam a extensão.TXT. String de leitura e gravação.

Comentários

A extensão do nome de arquivo para arquivos de assistente é .act, e os arquivos são instalados na pasta \Arquivos de Programas\Microsoft Office\Office\Atores no Windows95 e na pasta \Windows\MsApps\Atores no Windows NT.

Os seguintes nomes de arquivo correspondem aos Assistentes do Office97.

Personagem	Nome do arquivo
Office Logo	Logo.act
SuperDog	Powerpup.act
Gênio	Genius.act
Robô	Hoverbot.act
Rabisco	Scribble.act
Pingo	Dot.act
Clip	Clippit.act
Natureza	MNature.act
William	Will.act


Exemplo da propriedade FileName

Este exemplo usa a propriedade FileName para personalizar o texto do balão para Assistentes do Office específicos. A variável btext pode ser usada para o valor da propriedade Text em um balão Assistente de Impressão.

Select Case Assistant.FileName

Case "will.act"

    btext = "To Print, or Not to Print. That is the question."

Case "genius.act"

    btext = "The sum of the checkboxes equals the document to print."

Case Else

    btext = "Choose the document you want to print."

End Select

Este exemplo localiza todos os arquivos encontrados na pasta My documents que se iniciam com "cmd". O exemplo exibe o nome e o local de cada arquivo localizado.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Propriedade BalloonType

Retorna ou define o tipo de balão usado pelo Assistente do Office. Pode ser uma das seguintes constantes MsoBalloonType: msoBalloonTypeButtons, msoBalloonTypeBullets ou msoBalloonTypeNumbers. Quando você cria um novo balão com o método NewBalloon, essa propriedade é inicialmente definida como msoBalloonTypeButtons. Long de leitura e gravação.


Exemplo da propriedade BalloonType

Este exemplo cria um balão de instruções que explica como selecionar uma impressora. O balão não é modal, portanto o usuário pode seguir as instruções do balão enquanto trabalha, mantendo o balão visível.

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    .Labels(1).Text = "From the File menu, choose Print."

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With


Propriedade Button

Retorna ou define o tipo de botão exibido na parte inferior do balão do Assistente do Office. Quando você cria um novo balão com o método NewBalloon, essa propriedade é inicialmente definida como msoButtonSetOK. Long de leitura e gravação.

Pode ser uma das seguintes constantes MsoButtonSetType:

msoButtonSetAbortRetryIgnore msoButtonSetBackClose msoButtonSetBackNextClose msoButtonSetBackNextSnooze msoButtonSetCancel msoButtonSetNextClose msoButtonSetNone msoButtonSetOK	msoButtonSetOkCancel msoButtonSetRetryCancel msoButtonSetSearchClose msoButtonSetTipsOptionsClose msoButtonSetYesAllNoCancel msoButtonSetYesNoCancel msoButtonSetYesNo


Exemplo da propriedade Button

Este exemplo cria um balão com um título, texto e três escolhas de região e, em seguida, o exibe.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

End With


Propriedade Checkboxes

Retorna a coleção BalloonCheckboxes que representa todas as caixas de seleção contidas no balão especificado. Somente para leitura.

Para obter informações sobre como retornar um único membro de uma coleção, consulte Retornar um objeto de uma seleção.


Exemplo da propriedade Checkboxes

É possível um usuário selecionar mais de uma caixa de seleção antes de clicar no botão OK. Caso desejado, você pode alterar o código para que isso aconteça. O exemplo a seguir avalia cada caixa de seleção individualmente.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


Propriedade Checked

True se a caixa de seleção especificada no balão do Assistente do Office está marcada. Boolean de leitura e gravação.


Exemplo da propriedade Checked

Este exemplo cria um balão com um título, texto e três escolhas de região. Quando o usuário marca uma caixa de seleção e, em seguida, clica em OK no balão, o procedimento apropriado é executado.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


Propriedade FeatureTips

True se o Assistente do Office exibe informações sobre o uso mais eficiente de recursos do aplicativo. Boolean de leitura e gravação.

Comentários

A propriedade FeatureTips corresponde à caixa de seleção Uso mais eficiente de recursos na guia Opções da caixa de diálogo Assistente.


Exemplo da propriedade FeatureTips

Este exemplo define o Assistente do Office a para fornecer informações sobre o uso mais eficiente dos recursos do aplicativo.

Assistant.FeatureTips = True


Propriedade GuessHelp

True se o Assistente do Office exibe uma lista dos tópicos relevantes da Ajuda com base no contexto de imediatamente antes do usuário clicar na janela do Assistente ou pressionar F1. Boolean de leitura e gravação.

Comentários

A propriedade GuessHelp corresponde à opção Adivinhar tópicos da Ajuda sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade GuessHelp

Este exemplo faz o Assistente do Office adivinhar nos tópicos da Ajuda.

Assistant.GuessHelp = True


Propriedade Heading

Retorna ou define o título que aparece no balão do Assistente do Office. String de leitura e gravação.

Comentários

Você pode especificar a exibição de um gráfico, usando a seguinte sintaxe: {tipo local fator_dimensão}, onde tipo é bmp (bitmap), ou wmf (metarquivo do Windows); local é a identificação do recurso ou o caminho e nome de arquivo, e fator_dimensão especifica a largura do wmf (omitido no bmp).


Exemplo da propriedade Heading

Este exemplo cria um balão com um título, texto e três escolhas de região e, em seguida, o exibe.

With Assistant.NewBalloon

    .Button = msoButtonSetOkCancel

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Método Help

Exibe o Assistente do Office e o balão do Assistente interno.

Sintaxe

expressão.Help

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant.


Exemplo do método Help

Este exemplo exibe o balão do Assistente interno quando o usuário seleciona a caixa de seleção "I need more information".

Set b = Assistant.NewBalloon

With b

    .Heading = "User Information"

    .Text = "Select your skill level"

    .CheckBoxes(1).Text = "Beginner."

    .CheckBoxes(2).Text = "Advanced."

    .CheckBoxes(3).Text = "I need more information."

    .Show

End With

If b.CheckBoxes(3).Checked = True Then

    Assistant.Help

End If


Propriedade AssistWithWizards

True se o Assistente do Office oferece informações de Ajuda sobre assistentes. Boolean de leitura e gravação.

Comentários

A propriedade AssistWithWizards corresponde à opção Ajuda para os assistentes sob Recursos do assistente na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade AssistWithWizards

Este exemplo faz o Assistente do Office oferecer informações de Ajuda sobre assistentes.

Assistant.AssistWithWizards = True


Propriedade HighPriorityTips

True se o Assistente do Office exibe dicas de alta prioridade. Boolean de leitura e gravação.

Comentários

A propriedade HighPriorityTips corresponde à opção Mostrar apenas dicas de alta prioridade sob Outras opções de dica na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade HighPriorityTips

Este exemplo faz o Assistente do Office exibir dicas de alta prioridade.

Assistant.HighPriorityTips = True


Propriedade Icon

Retorna ou define o tipo de ícone que aparece na parte superior esquerda do balão do Assistente do Office. Pode ser uma das seguintes constantes MsoIconType: msoIconAlert, msoIconNone ou msoIconTip. String de leitura e gravação.


Exemplo da propriedade Icon

Este exemplo cria um balão com um ícone de alerta que instrui o usuário a selecionar uma impressora.

With Assistant.NewBalloon

    .Heading = "Select A Printer"

    .Text = "You must select a printer before printing."

    .Icon = msoIconAlert

    .CheckBoxes(1).Text = "Local printer"

    .CheckBoxes(2).Text = "Network printer"

    .Show

End With


Propriedade KeyboardShortcutTips

True se o Assistente do Office oferece informações de Ajuda sobre atalhos do teclado. Boolean de leitura e gravação.

Comentários

A propriedade KeyboardShortcutTips corresponde à opção Atalhos do teclado sob Mostrar dicas sobre na guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade KeyboardShortcutTips

Este exemplo faz o Assistente do Office oferecer informações de Ajuda sobre atalhos do teclado.

Assistant.KeyboardShortcutTips = True


Propriedade Labels

Retorna uma coleção BalloonLabels representando os rótulos de botão, os rótulos de número e os rótulos de marcadores contidos no balão do Assistente do Office especificado. Somente para leitura.

Para obter informações sobre como retornar um único membro de uma coleção, consulte Retornar um objeto de uma seleção.


Exemplo da propriedade Labels

Este exemplo cria um balão contendo três escolhas. A variável x é definida com o valor retornado pelo método Show, o que será 1, 2 ou 3, correspondendo ao rótulo no qual o usuário clica. Neste exemplo, uma caixa de mensagem simples exibe o valor da variável x, mas você pode passar o valor para um outro procedimento, ou pode usar o valor em uma instrução Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x


Propriedade BalloonError

Retorna um valor indicando o último erro de balão registrado. String somente para leitura.

Pode ser uma das seguintes constantes MsoBalloonErrorType.

Constante	Descrição
msoBalloonErrorBadPictureRef	O balão contém um bitmap que não pôde ser exibido porque o arquivo não existe ou porque o bitmap não é um arquivo .BMP ou .WMF válido.
msoBalloonErrorBadReference	O balão contém uma referência não reconhecida ou não suportada.
msoBalloonErrorButtonlessModal	O balão que você tentou exibir é modal, mas não contém botão algum. O balão não será exibido porque não pode ser descartado.
msoBalloonErrorButtonModeless	O balão que você tentou exibir não é modal, não contém botões e não tem nenhum procedimento atribuído à propriedade Callback. O balão não será exibido porque é necessário um procedimento para avaliar o botão clicado no balão.
msoBalloonErrorNone	A propriedade teve êxito em exibir o balão; nenhum erro foi encontrado.
msoBalloonErrorOther	O balão não aparecerá porque algum outro erro ocorreu, como outro balão modal já está ativo.


Exemplo da propriedade BalloonError

Este exemplo cria um balão que gera um erro. O erro é causado porque o balão é criado sem uma maneira de ser descartado: o tipo de botão foi definido como msoButtonSetNone e o modo de balão padrão é msoModeModal, resultando em um balão sem botões. Observe que não há maneira de descartar um balão modal sem botões.

With Application.Assistant

With .NewBalloon

    .Heading = "This will never show."

    .Text = "Imagine a balloon here."

    .Button = msoButtonSetNone

    .Show

End With

.Visible = True

If .BalloonError = msoBalloonErrorButtonlessModal Then

    MsgBox "You need a button to dismiss the balloon."

End If

End With


Propriedade Mode

Retorna ou define o tipo de balão exibido. Pode ser uma das seguintes constantes MsoModeType: msoModeAutoDown, msoModeModal ou msoModeModeless. Quando você cria um novo balão com o método NewBalloon, essa propriedade é inicialmente definida como msoModeModal. Long de leitura e gravação.

Comentários

Quando a propriedade Mode de um balão está definida como msoModeModeless, o usuário pode trabalhar no aplicativo enquanto o balão está visível. Se a propriedade estiver definida como msoModeModal, o usuário terá que descartar o balão antes de poder voltar a trabalhar no aplicativo. Se a propriedade estiver definida como msoModeAutoDown, o balão será instantaneamente descartado quando o usuário clicar em qualquer lugar da tela.

Se a propriedade Mode de um balão estiver definida como msoModeModeless, será necessário um valor para a propriedade Callback. O método Close só pode ser usado quando a propriedade está definida como msoModeModeless.


Exemplo do método Mode

Este exemplo cria um balão com um ícone de alerta que instrui o usuário a selecionar uma impressora. Como o balão não é modal, o usuário tem acesso a comandos de impressora enquanto o balão está visível.

With Assistant.NewBalloon

    .Heading = "Select A Printer"

    .Text = "You must select a printer before printing."

    .Icon = msoIconAlert

    .CheckBoxes(1).Text = "Local printer"

    .CheckBoxes(2).Text = "Network printer"

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Show

End With


Propriedade MouseTips

True se o Assistente do Office oferece sugestões para um uso mais eficaz do mouse. De leitura e gravação. Boolean.

Comentários

A propriedade MouseTips corresponde à opção Uso mais eficiente do mouse sob Mostrar dicas sobre da guia Opções da caixa de diálogo Assistente do Office.


Exemplo da propriedade MouseTips

Este exemplo faz o Assistente do Office oferecer sugestões para um uso mais eficaz do mouse.

Assistant.MouseTips = True


Objeto Assistant

Representa o Assistente do Microsoft Office.

Uso do objeto Assistant

Use a propriedade Assistant para retornar o objeto Assistant. Não há coleção para o objeto Assistant; apenas um objeto Assistant pode estar ativo de cada vez. Use a propriedade Visible para exibir o Assistente.

Comentários

O Assistente padrão é Clip. Para selecionar por programa um Assistente diferente, use a propriedade FileName.

O exemplo seguinte exibe um Assistente selecionado anteriormente e o anima com o som associado. Se o seu computador não tem uma placa de som instalada, este exemplo não irá gerar um erro, mas o som não será ouvido.

With Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


Objeto Balloon

Representa o balão no qual o Assistente do Office exibe títulos e informações de texto. Um balão pode conter controles tais como caixas de seleção e rótulos.

Uso do objeto Balloon

Use a propriedade NewBalloon para retornar um objeto Balloon. Não há coleção para o objeto Balloon; apenas um balão pode estar visível de cada vez. No entanto, é possível definir vários balões e chamar qualquer um deles quando necessário. Para obter maiores informações, consulte "Definir e reutilizar balões" posteriormente neste tópico.

Use o método Show para tornar visível o balão especificado. Use a propriedade Callback para executar procedimentos com base em seleções de balões não modais (balões que permanecem visíveis enquanto um usuário trabalha com o aplicativo). Use o método Close para fechar balões não modais.

O exemplo seguinte cria um balão contendo dicas para salvamento de dados inseridos.

With Assistant.NewBalloon

    .BalloonType = msoBalloonTypeBullets

    .Icon = msoIconTip

    .Button = msoButtonSetOkCancel

    .Heading = "Tips for Saving Information."

    .Labels(1).Text = "Save your work often."

    .Labels(2).Text = "Install a surge protector."

    .Labels(3).Text = "Exit your application properly."

    .Show

End With

Definir e reutilizar balões

Você pode reutilizar balões atribuindo-os a variáveis de objeto e chamando-os quando necessário ao longo de seu procedimento. Este exemplo define balloon1, balloon2 e balloon3 como balões separados, e exibe os balões em vários pontos do procedimento.

Set balloon1 = Assistant.NewBalloon

balloon1.Heading = "First balloon"

Set balloon2 = Assistant.NewBalloon

balloon2.Heading = "Second balloon"

Set balloon3 = Assistant.NewBalloon

balloon3.Heading = "Third balloon"

balloon1.Show

balloon3.Show

balloon2.Show

Você também pode combinar variáveis de objeto balão em uma matriz e indexar a matriz.


Objeto da coleção BalloonCheckboxes

Uma coleção de objetos BalloonCheckbox representando todas as caixas de seleção no balão do Assistente do Office.

Uso da coleção BalloonCheckboxes

Use a propriedade Checkboxes para retornar a coleção BalloonCheckboxes.

Use Checkboxes(índice), onde índice é um número de 1 a 5, para retornar um único objeto BalloonCheckbox. Pode haver até cinco caixas de seleção em um balão; cada caixa de seleção aparece quando um valor é atribuído à sua propriedade Text.

O exemplo seguinte escreve na janela de depuração o texto de todas as caixas de seleção visíveis de um balão existente.

For Each box In .CheckBoxes

    If box.Text <> "" Then

        Debug.Print box.Text

    End If

Next

Você não pode adicionar ou remover caixas de seleção na coleção BalloonCheckBoxes.

Comentários

As caixas de seleção de balão exibem as escolhas do usuário até que este descarte o balão. Os rótulos de balão registram a escolha do usuário assim que este clica no botão ao lado do rótulo.


Objeto BalloonCheckbox

Representa uma caixa de seleção no balão do Assistente do Office. O objeto BalloonCheckbox é um membro da coleção BalloonCheckboxes.

Uso do objeto BalloonCheckbox

Use Checkboxes(índice), onde índice é um número de 1 a 5, para retornar um único objeto BalloonCheckbox. Pode haver até cinco caixas de seleção em um balão; cada caixa de seleção aparece quando um valor é atribuído à sua propriedade Text.

O exemplo seguinte cria um balão com um título, texto e três escolhas de região. Quando o usuário marca uma caixa de seleção e, em seguida, clica em OK, o procedimento apropriado é executado.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

    Select Case True

        Case .CheckBoxes(1).Checked

            runregion1

        Case .CheckBoxes(2).Checked

            runregion2

        Case .CheckBoxes(3).Checked

            runregion3

    End Select

End With

Comentários

As caixas de seleção de balão exibem as escolhas do usuário até que este descarte o balão. Os rótulos de balão registram a escolha do usuário assim que este clica no botão ao lado do rótulo.


Objeto da coleção BalloonLabels

Uma coleção de objetos BalloonLabel representando todos os rótulos no balão do Assistente do Office.

Uso da coleção BalloonLabels

Use a propriedade Labels para retornar a coleção BalloonLabels.

Use Labels(índice), onde índice é um número de 1 a 5, para retornar um objeto BalloonLabel. Pode haver até cinco rótulos em um balão; cada rótulo aparece quando um valor é atribuído a sua propriedade Text.

O exemplo seguinte cria um balão com três opções. A variável x é definida para retornar um valor do método Show, que será 1, 2 ou 3, correspondendo ao rótulo que o usuário clicar. O exemplo exibe o valor da variável x, mas você pode passar o valor para outro procedimento, ou pode usar o valor em uma instrução Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x

Comentários

As caixas de seleção de balão exibem as escolhas do usuário até que este descarte o balão. Os rótulos de balão registram a escolha do usuário assim que este clica no botão ao lado do rótulo.


Objeto BalloonLabel

Representa um rótulo no balão do Assistente do Office. O objeto BalloonLabel é um membro da coleção BalloonLabels.

Uso do objeto BalloonLabel

Use Labels(índice), onde índice é um número de 1 a 5, para retornar um objeto BalloonLabel. Pode haver até cinco rótulos em um balão; cada rótulo aparece quando um valor é atribuído à sua propriedade Text.

O exemplo seguinte cria um balão que pede ao usuário para clicar no rótulo correspondente à sua idade.

With Assistant.NewBalloon

    .Heading = "Check Your Age Group."

    .Labels(1).Text = "Under 30."

    .Labels(2).Text = "Over 30."

    .Labels(3).Text = "None of your business."

    .Text = "Which of the following " _

        & .Labels.Count & " choices apply to you?"

    .Show

End With

Comentários

As caixas de seleção de balão exibem as escolhas do usuário até que este descarte o balão. Os rótulos de balão registram a escolha do usuário assim que este clica no botão ao lado do rótulo.


Método Add

Adiciona um objeto a uma coleção. Selecione uma das coleções seguintes para ver uma descrição detalhada do método Add para essa coleção.

CommandBarControls

CommandBars

DocumentProperties

PropertyTests


Método Add (coleção CommandBarControls)

Cria um novo controle de barra de comando e o adiciona à coleção de controles da barra de comando especificada. Retorna um objeto CommandBarButton, CommandBarComboBox ou CommandBarPopup.

Sintaxe

expressão.Add(Type, Id, Parameter, Before, Temporary)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarControls.

Type   Variant opcional. O tipo de controle a ser adicionado à barra de comando especificada. Pode ser uma das seguintes constantes MsoControlType: msoControlButton, msoControlEdit, msoControlDropdown, msoControlComboBox ou msoControlPopup.

Id   Variant opcional. Um número inteiro que especifique um controle interno. Se o valor desse argumento for 1, ou se esse argumento for omitido, um controle personalizado em branco do tipo especificado será adicionado à barra de comando.

Parameter   Variant opcional. Para controles internos, esse argumento é usado pelo aplicativo recipiente para executar o comando. Para controles personalizados, você pode usar esse argumento para enviar informações para procedimentos do Visual Basic, ou pode usá-lo para armazenar informações sobre o controle (semelhante a um segundo valor de propriedade Tag).

Before   Variant opcional. Um número que indica a posição do novo controle na barra de comando. O novo controle será inserido antes do controle nessa posição. Se esse argumento for omitido, o controle será adicionado no final da barra de comando especificada.

Temporary   Variant opcional. True para tornar temporário o novo controle. Os controles temporários são excluídos automaticamente quando o aplicativo recipiente é fechado. O valor padrão é False.


Exemplo do método Add (coleção CommandBarControls)

Este exemplo adiciona um controle de botão com uma face de gráfico à barra de comando chamada "Custom" e, em seguida, atribui ao controle o procedimento chamado "Analyze".

Set custBar = CommandBars("Custom")

custBar.Visible = True

Set graphBtn = custBar.Controls.Add(Type:=msoControlButton)

graphBtn.FaceId = 17

graphBtn.OnAction = "Analyze"


Método Add (coleção CommandBars)

Cria uma nova barra de comando e a adiciona à coleção de barras de comando. Retorna um objeto CommandBar.

Sintaxe

expressão.Add(Name, Position, MenuBar, Temporary)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBars.

Name   Variant opcional. O nome da nova barra de comando. Se esse argumento for omitido, o Word atribuirá um nome padrão à barra de comando (tal como "Personalizada 1").

Position   Variant opcional. A posição da nova barra de comando. Pode ser uma das seguintes constantes MsoBarPosition.

Constante	Descrição
msoBarLeft, msoBarTop, msoBarRight, msoBarBottom	Indica as coordenadas esquerda, superior, direita e inferior da nova barra de comando
MsoBarFloating	Indica que a nova barra de comando não será ancorada
MsoBarPopup	Indica que a nova barra de comando será um menu de atalho
MenuBar   Variant opcional. True para substituir a barra de menu ativa pela nova barra de comando. O valor padrão é False.

Temporary   Variant opcional. True para tornar temporária a nova barra de comando. As barras de comando temporárias são excluídas quando o aplicativo recipiente é fechado. O valor padrão é False.


Exemplo do método Add (coleção CommandBars)

Este exemplo adiciona uma barra de comando de nível máximo chamada "Custom" que não será salva quando a sessão terminar. O exemplo também adiciona um botão interno de verificação ortográfica à barra de comando.

Set mybar = CommandBars _

    .Add(Name:="Custom", Position:=msoBarTop, _

    Temporary:=True)

With mybar

    .Controls.Add Type:=msoControlButton, Id:=2

    .Visible = True

End With


Método Add (coleção DocumentProperties)

Cria uma nova propriedade personalizada de documento. Você só pode usar esse método com a coleção de propriedades personalizadas de documento.

Sintaxe

expressão.Add(Name, LinkToContent, Type, Value, LinkSource)

expressão   Obrigatória. O objeto DocumentProperties personalizado.

Name   String obrigatória. O nome da propriedade.

LinkToContent   Boolean obrigatório. Especifica se a propriedade é vinculada ao conteúdo do documento recipiente. Se esse argumento for True, o argumento LinkSource será obrigatório; se for False, o argumento de valor será obrigatório.

Type   Long obrigatório. O tipo de dados da propriedade. Pode ser uma das seguintes constantes MsoDocProperties: msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber ou msoPropertyTypeString.

Value   Variant opcional. O valor da propriedade se ela não estiver vinculada ao conteúdo do documento recipiente. O valor é convertido para coincidir com o tipo de dados especificado pelo argumento de tipo, se possível; caso contrário, ocorre um erro. Se LinkToContent for True, o argumento Value será ignorado e a nova propriedade do documento terá um valor padrão até que valores de propriedade vinculados sejam atualizados pelo aplicativo recipiente (normalmente, quando o documento é salvo).

LinkSource   Boolean opcional. Ignorado se LinkToContent for False. A origem da propriedade vinculada. O aplicativo recipiente determina que tipo de vinculação de origem você pode usar.


Exemplo do método Add (coleção DocumentProperties)

Este exemplo adiciona uma nova propriedade personalizada de documento e a nomeia como "Complete". Você precisa passar a coleção DocumentProperties personalizada para o procedimento.

Sub AddCustomProperty(dp As DocumentProperties)

    dp.Add name:="Complete", linkToContent:=False, _

    type:=msoPropertyTypeBoolean, value:=False

End Sub


Método Add (coleção PropertyTests)

Adiciona um objeto PropertyTest à coleção PropertyTests.

Sintaxe

expressão.Add(Name, Condition, Value, SecondValue, Connector)

expressão   Uma expressão que retorne um objeto PropertyTests.

Name   String obrigatória. O nome do critério de propriedade. O nome corresponde a um valor na caixa Propriedade da caixa de diálogo Localização avançada.

Condition   Variant obrigatória. A condição do critério de pesquisa. Pode ser uma das seguintes constantes MsoCondition:

MsoConditionAnyNumberBetween MsoConditionAnytime MsoConditionAnytimeBetween MsoConditionAtLeast MsoConditionAtMost MsoConditionBeginsWith MsoConditionDoesNotEqual MsoConditionEndsWith MsoConditionEquals MsoConditionFileTypeAllFiles MsoConditionFileTypeBinders MsoConditionFileTypeDatabases MsoConditionFileTypeExcelWorkbooks MsoConditionFileTypeOfficeFiles MsoConditionFileTypePowerPointPresentations MsoConditionFileTypeTemplates MsoConditionFileTypeWordDocuments MsoConditionIncludesNearEachOther MsoConditionIncludesPhrase MsoConditionInTheLast	msoConditionInTheNext msoConditionIsExactly msoConditionIsNo msoConditionIsNot msoConditionIsYes msoConditionLastMonth msoConditionLastWeek msoConditionLessThan msoConditionMoreThan msoConditionNextMonth msoConditionNextWeek msoConditionOn msoConditionOnorAfter msoConditionOnorBefore msoConditionThisMonth msoConditionThisWeek msoConditionToday msoConditionTomorrow msoConditionYesterday
Value   Variant opcional. O valor do critério de pesquisa pelo qual testar.

SecondValue   Variant opcional. Um valor superior para o intervalo de pesquisa. Você só pode usar esse argumento se Condition for msoConditionAnyTimeBetween ou msoConditionAnyNumberBetween.

Connector   Variant opcional. Especifica a maneira como dois critérios de pesquisa são combinados. Pode ser uma das seguintes constantes msoConnector: msoConnectorAnd ou msoConnectorOr.


Exemplo do método Add (coleção PropertyTests)

Este exemplo adiciona dois testes de propriedade ao critério de pesquisa. O primeiro teste é que os arquivos localizados sejam documentos do Word, e o segundo teste é que os arquivos localizados devam ter sido modificados entre 1º de janeiro de 1996 e 30 de junho de 1996.

Set fs = Application.FileSearch

fs.NewSearch

With fs.PropertyTests

    .Add Name:="Files of Type", _

        Condition:=msoConditionFileTypeWordDocuments, _

        Connector:=msoConnectorOr

    .Add Name:="Last Modified", _

        Condition:=msoConditionAnytimeBetween, _

        Value:="1/1/96", SecondValue:="6/30/96", _

        Connector:=msoConnectorAnd

End With


Método Copy

Copia o controle de barra de comando especificado para uma barra de comando existente.

Sintaxe

expressão.Copy(Bar, Before)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarControl, CommandBarButton, CommandBarPopup, ou CommandBarComboBox.

Bar   Variant opcional. Um objeto CommandBar representando a barra de comando de destino. Se esse argumento for omitido, o controle será copiado para a mesma barra de comando (a barra de comando na qual ele já se encontra).

Before   Variant opcional. Um número que indica a posição do novo controle na barra de comando especificada. O novo controle será inserido antes do controle nessa posição. Se esse argumento for omitido, o controle será copiado para o final da barra de comando.


Exemplo do método Copy

Este exemplo copia o primeiro controle da barra de comando chamada "Standard" para a barra de comando chamada "Custom" e o posiciona lá como primeiro controle também. O exemplo atribui um novo parâmetro ao controle e define o foco para o novo botão.

Set myCustomBar = CommandBars("Custom")

Set myControl = CommandBars("Standard").Controls(1)

With myControl

.Copy Bar:=myCustomBar, Before:=1

.Parameter = "2"

.SetFocus

End With


Propriedade Count

Retorna o número de itens na coleção especificada. Long somente para leitura.

Comentários

Para a coleção CommandBars, a contagem só inclui barras de menu, barras de ferramentas e menus de atalho. Os menus e submenus não são incluídos.


Exemplo da propriedade Count

Este exemplo usa a propriedade Count para exibir o número de barras de comando da coleção.

MsgBox "There are " & CommandBars.Count & " bars in your collection."

Este exemplo usa a propriedade Count para exibir o número de caixas de seleção no balão do Assistente do Office.

With Assistant.NewBalloon

    .CheckBoxes(1).Text = "First Choice"

    .CheckBoxes(2).Text = "Second Choice"

    .Text = "You have the following " _

    & .CheckBoxes.Count & " choices."

    .Show

End With

Este exemplo usa a propriedade Count para exibir o número de rótulos no balão do Assistente do Office.

With Assistant.NewBalloon

    .Heading = "Check Your Age Group."

    .Labels(1).Text = "20 to 29."

    .Labels(2).Text = "30 to 39."

    .Labels(3).Text = "40 or over"

    .Text = "Which of the following " _

    & .Labels.Count & " choices apply to you?"

    .Show

End With

Este exemplo exibe o número de propriedades de documento na coleção DocumentProperties que foi passada para o procedimento.

Sub CountDocumentProperties(dp As DocumentProperties)

    MsgBox "There are " & dp.Count & " properties in the collection."

End Sub


Método Delete

Exclui o objeto especificado da coleção na qual ele está contido.

Sintaxe 1

expressão.Delete

Sintaxe 2

expressão.Delete(Temporary)

Syntax 3

expression.Delete(BstrQueryName)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBar ou DocumentProperty (Sintaxe 1), ou um objeto CommandBarControl (Sintaxe 2), ou um objeto FileFind (Syntax 3).

Temporary   Variant opcional. True para excluir o controle da sessão atual. O aplicativo exibirá novamente o controle na próxima sessão.

BstrQueryName   String obrigatória. Uma seqüência de caracteres contendo até 31 caracteres indicando o nome do critério de pesquisa salvo a ser excluído.

Comentários

Você não pode excluir uma propriedade interna de documento.


Exemplo do método Delete

Este exemplo exclui todas as barras de comando personalizadas que não estão visíveis.

foundFlag = False

delBars = 0

For Each bar In CommandBars

    If (bar.BuiltIn = False) And _

    (bar.Visible = False) Then

        bar.Delete

        foundFlag = True

        delBars = delBars + 1

    End If

Next

If Not foundFlag Then

    MsgBox "No command bars have been deleted."

Else

    MsgBox delBars & " custom bar(s) deleted."

End If

Este exemplo exclui uma propriedade personalizada de documento. Você precisa passar um objeto DocumentProperty para o procedimento.

Sub DeleteCustomDocumentProperty(dp As DocumentProperty)

    dp.Delete

End Sub


Método Execute

Executa um procedimento associado a um controle de barra de comando ou inicia uma pesquisa por arquivos. Selecione um dos objetos seguintes para ver uma descrição detalhada do método Execute para esse objeto.

CommandBarButton

CommandBarControl

CommandBarPopup

CommandBarComboBox

FileSearch

FileFind


Método Execute (controles de barra de comando)

Executa a macro ou comando interno atribuído ao controle de barra de comando especificado. Para controles personalizados, use a propriedade OnAction para especificar a macro a ser executada.

Sintaxe

expressão.Execute

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarControl, CommandBarButton, CommandBarPopup, ou CommandBarComboBox.


Exemplo do método Execute (controles de barra de comando)

Este exemplo verifica o valor do controle caixa de combinação na barra de comando personalizada chamada "My Command Bar". Se o valor for "First", o exemplo executará a macro especificada pela propriedade OnAction do controle de barra de comando.

Set mycontrol = CommandBars("My Custom Bar").Controls(1)

With mycontrol

If .List(.ListIndex) = "First" Then

mycontrol.Execute

   End If

End With


Método Execute (objeto FileSearch)

Objeto FileSearch: Inicia a pesquisa pelos arquivos especificados.

Objeto FileFind: Inicia a procura por arquivos especificados e atualiza a coleção FindFileResults. Macintosh apenas.

Syntax 1

expressão.Execute(SortBy, SortOrder, AlwaysAccurate)

Syntax 2

expressão.Execute(SortBy, SortOrder, AlwaysAccurate)

expressão   Obrigatória. Uma expressão que retorne um objeto FileSearch.

SortBy   Variant opcional. O método usado para classificar os arquivos retornados. Pode ser uma das seguintes constantes MsoSortBy: msoSortbyFileName, msoSortbyFileType, msoSortbyLastModified ou msoSortbySize.

SortOrder   Variant opcional. A ordem na qual os arquivos retornados devem ser classificados. Pode ser uma das seguintes constantes MsoSortOrder: msoSortOrderAscending ou msoSortOrderDescending.

AlwaysAccurate   Boolean opcional. True para que a pesquisa de arquivos incluam arquivos que tenham sido adicionados, modificados ou excluídos desde que o índice de arquivos foi atualizado pela última vez. O valor padrão é True.


Exemplo do método Execute (objeto FileSearch)

Este exemplo pesquisa por todos os arquivos que começam por "cmd" na pasta My Documents e exibe o local e o nome de cada arquivo localizado. O exemplo classifica a lista de arquivos retornados em ordem alfabética crescente, por nome de arquivo.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute(SortBy:=msoSortbyFileName, _

            SortOrder:=msoSortOrderAscending) > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Método SetFocus

Move o foco do teclado para o controle de barra de comando especificado, para que este possa receber entrada pelo teclado. O tipo de entrada pelo teclado que você pode direcionar para o controle depende de que tipo de controle ele seja.

Observação Se o controle estiver desativado ou não estiver visível a partir do estado atual, este método irá falhar.

Sintaxe

expressão.SetFocus

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarControl, CommandBarButton, CommandBarPopup, ou CommandBarComboBox.


Exemplo do método SetFocus

Este exemplo copia o quarto controle da barra de comando personalizada My Custom Bar e o cola na mesma barra de comando como primeiro controle. O exemplo também atribui um novo parâmetro ao controle e define o foco para o novo botão.

Set mycontrol = CommandBars("My Custom Bar") _

    .Controls(4)

With mycontrol

.Copy Before:=1

.Parameter = "2"

.SetFocus

End With


Propriedade Text

Objeto CommandBarComboBox: Retorna ou define o texto da parte de exibição ou edição do controle caixa de combinação da barra de comando.  String de leitura e gravação.

Objeto BalloonLabel ou BalloonCheckbox: Retorna ou define o texto exibido próximo à caixa de seleção ou rótulo especificado no balão do Assistente do Office. String de leitura e gravação.

Objeto Balloon: Retorna ou define o texto exibido após o título mas antes dos rótulos ou caixas de seleção do balão do Assistente do Office. String de leitura e gravação.

Objeto FileFind: Retorna ou define a seqüência de caracteres a ser procurada, com até 80 caracteres, em todo o documento, durante uma pesquisa no arquivo. Somente para Macintosh. String de leitura e gravação.

Comentários

Para os objetos Balloon, BalloonLabel e BalloonCheckbox, você pode especificar um gráfico a ser exibido usando a seguinte sintaxe: {tipo local fator_de_dimensionamento}, onde tipo é bmp (bitmap), wmf (metarquivo do Windows) ou pict (arquivo PICT do Macintosh); local é o identificador de recurso do caminho e nome de arquivo; e fator_de_dimensionamento especifica a largura do wmf ou pict (omitido para bmp).


Exemplo da propriedade Text

Este exemplo verifica o número de itens do controle caixa de combinação na barra de comando chamada "Custom". Se houver mais de três itens na lista, o exemplo limpará a lista e adicionará à mesma um novo primeiro item. O novo item padrão para esse controle é "Floyd".

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls(2)

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem "Floyd", 1

        .Text = "Floyd"

    End If

End With

Este exemplo cria um novo balão de Assistente do Office com um título, texto e três escolhas de região. O exemplo usa a propriedade Text para fornecer um rótulo para cada caixa de seleção.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With

Este exemplo cria um novo balão de Assistente do Office com um título, texto e três escolhas de região. O exemplo usa a propriedade Text para fornecer instruções relacionadas ao balão para o usuário.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Propriedade Top

Objeto CommandBar ou CommandBarControl: Retorna ou define a distância (em pixels) da extremidade superior da barra de comando ou controle de barra de comando especificado até a extremidade superior da tela. Para barras de comando ancoradas, essa propriedade retorna ou define a distância da barra de comando até a extremidade superior da área de ancoragem. Long de leitura e gravação para CommandBar, Long somente para leitura para CommandBarControl.

Objeto Assistant: Retorna ou define a posição vertical da janela Assistente do Office (em pontos), em relação à tela. Integer de leitura e gravação.


Exemplo da propriedade Top

Este exemplo posiciona o canto superior esquerdo da barra de comando flutuante chamada "Custom" a 140 pixels da extremidade esquerda da tela e a 100 pixels da extremidade superior da tela.

Set myBar = CommandBars("Custom")

myBar.Position = msoBarFloating

With myBar

    .Left = 140

    .Top = 100

End With

Este exemplo move o Assistente do Office para a coordenada especificada.

Assistant.Top = 500


Propriedade HelpContextId

Retorna ou define o número de identificação do contexto da Ajuda para o tópico da Ajuda anexado ao controle de barra de comando. Long de leitura e gravação.

Comentários

Para usar essa propriedade, você também precisa definir a propriedade HelpFile.


Exemplo da propriedade HelpContextId

Este exemplo adiciona um botão gerenciador de relatório personalizado ao menu File e especifica que um tópico de Ajuda seja exibido como Ajuda sensível ao contexto desse botão.

Set fileMenu = CommandBars _

    .FindControl(Type:=msoControlPopup, Id:=fileID)

Set fileMenuDropdown = fileMenu.CommandBar

Set newButton = fileMenuDropdown.Controls _

    .Add(Type:=msoControlButton, Before:=3)

With newButton

    .Caption = "Open Report"

    .DescriptionText = "Opens a quarterly report form"

    .OnAction = "ReportManager"

    .HelpFile = "C:\corphelp\custom.hlp"

    .HelpContextID = 47

End With


Propriedade HelpFile

Retorna ou define o nome do arquivo de Ajuda para o tópico da Ajuda anexado ao controle de barra de comando. String de leitura e gravação.

Comentários

Para usar essa propriedade, você também precisa definir a propriedade HelpContextID.


Exemplo da propriedade HelpFile

Este exemplo adiciona um botão gerenciador de relatório personalizado ao menu File e especifica que um tópico de Ajuda seja exibido como Ajuda sensível ao contexto desse botão.

Set fileMenu = CommandBars _

   .FindControl(Type:=msoControlPopup, Id:=fileId)

Set fileMenuDropdown = fileMenu.CommandBar

Set newbutton = fileMenuDropdown.Controls _

    .Add(Type:=msoControlButton, Id:=customId, Before:=3)

With newButton

    .Caption = "Open Report"

    .DescriptionText = "Opens a quarterly report form"

    .OnAction = "ReportManager"

    .HelpFile = "C:\corphelp\custom.hlp"

    .HelpContextID = 47

End With


Propriedade LargeButtons

True se são exibidos botões grandes de barras de ferramentas. Boolean de leitura e gravação.


Exemplo da propriedade LargeButtons

Este exemplo exibe botões grandes de barras de ferramentas e Dicas de tela sobre todas as barras de comando se a barra de menu principal ativa for chamada "Custom".

Set allBars = CommandBars

If allBars.ActiveMenuBar.Name = "Custom" Then

    allBars.LargeButtons = True

    allBars.ShowToolTips = True

End If


Propriedade List

Retorna ou define o valor de um item de lista no controle caixa de combinação da barra de comando.  String de leitura e gravação.

Observação   Esta propriedade é somente para leitura para controles caixa de combinação internos.

Sintaxe

expressão.List(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarComboBox.

Index   Long obrigatório. O item de lista a ser definido.


Exemplo da propriedade List

Este exemplo verifica o valor do quarto item de lista no controle caixa de combinação chamado "Vegetables" na barra de comando chamada "Custom". Se o valor for "Tomato", o código especificado pela propriedade OnAction do controle de barra de comando será executado.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls("Vegetables")

If myControl.List(4) = "Tomatoes" Then myControl.Execute


Propriedade ListCount

Retorna o número de itens de lista no controle caixa de combinação de barra de comando especificado.  Long somente para leitura.


Exemplo da propriedade ListCount

Este exemplo verifica o número de itens do controle caixa de combinação da barra de comando chamada "Custom". Se houver mais de três itens na lista, a lista será limpa e um novo primeiro item será adicionado e exibido como padrão para o controle caixa de combinação.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls(2)

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem Text:="Floyd", Index:=1

        .ListIndex = 1

    End If

End With


Propriedade ListHeaderCount

Retorna ou define o número de itens de lista no controle caixa de combinação de barra de comando que aparece acima da linha separadora. Long de leitura e gravação.

Observação   Esta propriedade é somente para leitura para controles caixa de combinação internos.

Comentários

Um valor de propriedade ListHeaderCount de  – 1 indica que não há linha separadora no controle caixa de combinação.


Exemplo da propriedade ListHeaderCount

O exemplo seguinte adiciona um controle caixa de combinação à barra de comando chamada "Custom" e, em seguida, adiciona dois itens à lista da caixa de combinação. O exemplo também define o número de itens de linha, a largura da caixa de combinação e um padrão em branco para a caixa de combinação.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem Text:="Second Item", Index:=2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 1

End With


Propriedade ListIndex

Retorna ou define o número de índice do item selecionado na parte lista do controle caixa de combinação de barra de comando.  Se nada for selecionado na lista, essa propriedade retornará zero. Long de leitura e gravação.

Observação   Essa propriedade falha quando aplicada a controles que não sejam controles de lista.

Comentários

A definição da propriedade ListIndex faz o controle especificado selecionar o item dado e executar a ação apropriada no aplicativo.


Exemplo da propriedade ListIndex

Este exemplo executa um procedimento existente, com base na seleção da caixa de combinação. O texto da caixa de combinação pode ser qualquer coisa, porque o exemplo usa a propriedade ListIndex ou o número de índice da entrada de texto para determinar qual procedimento será executado.

With myControl

    Select Case .ListIndex

        Case 1

            chartcourse

        Case 2

            displaygraph

        Case Else

           MsgBox "invalid choice"

    End Select

End With


Propriedade NameLocal

Retorna o nome de uma barra de comando interna como exibido na versão de idioma do aplicativo recipiente ou retorna ou define o nome de uma barra de comando personalizada. String de leitura e gravação.

Observação   Se você tentar definir essa propriedade para uma barra de comando interna, ocorrerá um erro.

Comentários

O nome local de uma barra de comando interna é exibido na barra de título (quando a barra de comando não está ancorada) e na lista de barras de comando disponíveis, onde quer que essa lista seja exibida no aplicativo recipiente.

Se você alterar o valor da propriedade LocalName para uma barra de comando personalizada, o valor de Name será alterado também, e vice-versa.


Exemplo da propriedade NameLocal

Este exemplo exibe o nome e o nome localizado da primeira barra de comando do aplicativo recipiente.

With CommandBars(1)

    MsgBox "The name of the command bar is " & .Name

    MsgBox "The localized name of the command bar is " & .NameLocal

End With


Propriedade OLEMenuGroup

Retorna ou define o grupo de menu ao qual o controle pop-up de barra de comando especificado pertence quando os grupos de menus do servidor OLE são mesclados com os grupos de menus de um cliente OLE (ou seja, quando um objeto do tipo do aplicativo recipiente é incorporado em um outro aplicativo). Pode ser uma das seguintes constantes MsoOLEMenuGroup: msoOleMenuGroupNone, msoOleMenuGroupFile, msoOleMenuGroupEdit, msoOleMenuGroupContainer, msoOleMenuGroupObject, msoOleMenuGroupWindow ou msoOleMenuGroupHelp. Long de leitura e gravação.

Observação   Essa propriedade é somente para leitura para controles internos.

Comentários

Essa propriedade tem o objetivo de permitir que aplicativos de suplemento especifiquem como seus controles de barra de comando serão representados no aplicativo do Office. Se o recipiente ou o servidor não implementar barras de comando, ocorrerá uma mesclagem de menus OLE normal: a barra de menu será mesclada, bem como todas as barras de ferramentas do servidor, e nenhuma das barras de ferramentas do recipiente. Essa propriedade só é relevante para controles pop-up na barra de menu porque os menus são mesclados com base em sua categoria de grupo de menu.

Se ambos os aplicativos sendo mesclados implementarem barras de comando, os controles de barra de comando serão mesclados conforme a propriedade OLEUsage.


Exemplo da propriedade OLEMenuGroup

Este exemplo verifica a propriedade OLEMenuGroup de um novo controle pop-up personalizado na barra de menu ativa e a define como msoOLEMenuGroupNone.

Set myControl = ActiveMenuBar.Controls _

    .Add(Type:=msoControlPopup,Temporary:=False)

myControl.OLEMenuGroup = msoOLEMenuGroupNone


Propriedade OLEUsage

Retorna ou define os papéis do cliente OLE e do servidor OLE nos quais um controle de barra de comando será usado quando dois aplicativos do Microsoft Office forem mesclados. Pode ser uma das seguintes constantes MsoControlOLEUsage: msoControlOLEUsageNeither, msoControlOLEUsageServer, msoControlOLEUsageClient ou msoControlOLEUsageBoth. Long de leitura e gravação.

Comentários

Essa propriedade tem o objetivo de permitir que você especifique de que maneira controles de barra de comando dos aplicativos de suplemento individuais serão representados em um aplicativo do Office quando forem mesclados com um outro aplicativo do Office. Se ambos o cliente e o servidor implementarem barras de comando, os controles de barra de comando serão incorporados no cliente, controle por controle. Os controles personalizados marcados como somente do cliente (ou nem do cliente nem do servidor) serão removidos do servidor, e os controles marcados como somente do servidor (ou nem do servidor nem do cliente) serão removidos do cliente. Os controles restantes serão mesclados.

Se nenhum dos aplicativos sendo mesclados for um aplicativo do Office, será usada uma mesclagem de menus OLE normal, a qual é controlada pela propriedade OLEMenuGroup.


Exemplo da propriedade OLEUsage

Este exemplo adiciona um novo botão à barra de comando chamada Tools e define sua propriedade OLEUsage.

Set myControl = CommandBars("Tools").Controls _

    .Add(Type:=msoControlButton,Temporary:=True)

myControl.OLEUsage = msoControlOLEUsageNeither


Propriedade OnAction

Retorna ou define o nome da macro do Visual Basic que será executada quando o usuário clicar ou alterar o valor de um controle de barra de comando.  String de leitura e gravação.

Observação   O aplicativo recipiente determina se o valor é um nome de macro válido.


Exemplo da propriedade OnAction

Este exemplo adiciona um controle de barra de comando à barra de comando chamada "Custom" e define a macro chamada "MySub" para ser executada sempre que o botão for clicado.

Set myBar = .CommandBars("Custom")

Set myControl = myBar.Controls _

    .Add(Type:=msocontrolButton)

With myControl

    .FaceId = 2

    .OnAction = "MySub"

End With

myBar.Visible = True


Propriedade Parameter

Retorna ou define uma seqüência de caracteres que um aplicativo pode usar para executar um comando associado a um controle de barra de comando.  String de leitura e gravação.

Comentários

Se o parâmetro especificado estiver definido para um controle interno, o aplicativo poderá modificar seu comportamento padrão se puder analisar e usar o novo valor. Se o parâmetro for definido para controles personalizados, ele só poderá ser usado para enviar informações para procedimentos do Visual Basic, ou poderá ser usado para guardar informações sobre o controle (semelhante a um segundo valor de propriedade Tag).


Exemplo da propriedade Parameter

Este exemplo copia o quarto controle da barra de comando personalizada chamada "Custom" e o cola na mesma barra de comando como novo primeiro controle. O exemplo atribui um novo parâmetro e define o foco para o novo botão.

Set myControl = CommandBars("Custom").Controls(4)

With myControl

    .Copy , 1

    .Parameter = "2"

    .SetFocus

End With


Método PasteFace

Cola o conteúdo da Área de transferência no controle de botão da barra de comando especificada.

Sintaxe

expressão.PasteFace

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarButton.


Exemplo do método PasteFace

Este exemplo localiza o botão ArquivoAbrir interno e cola nele uma face personalizada a partir da Área de transferência, onde o usuário a tinha alterado anteriormente. Este exemplo irá falhar se não houver já uma face personalizada na Área de transferência; use o método CopyFace para copiar uma face de botão especificada para a Área de transferência.

Set myControl = CommandBars.FindControl(Type:=msoControlButton, Id:=23)

myControl.PasteFace


Propriedade Position

Retorna ou define a posição da barra de comando especificada. Pode ser uma das seguintes constantes MsoBarPosition: msoBarLeft, msoBarTop, msoBarRight, msoBarBottom, msoBarFloating, msoBarPopup ou msoBarMenu. Long de leitura e gravação.


Exemplo da propriedade Position

Este exemplo percorre a coleção de barras de comando, ancorando as barras de comando personalizadas na parte inferior da janela do aplicativo e ancorando as barras de comando internas na parte superior da janela.

For Each bar In CommandBars

    If bar.Visible = True Then

        If bar.BuiltIn Then

            bar.Position = msoBarTop

         Else

            bar.Position = msoBarBottom

        End If

    End If

Next


Propriedade Priority

Retorna ou define a prioridade do controle de barra de comando especificado. A prioridade de um controle determina se ele pode ser descartado de uma barra de comando ancorada se os controles de barra de comando não couberem em uma única linha. Long de leitura e gravação.

Comentários

Uma prioridade de 1 significa que o controle não pode ser descartado. Os controles com os números de prioridade mais alto são descartados primeiro.

Uma prioridade de 0 indica um valor "automático", que implica em uma prioridade efetiva baseada no tipo de controle. Uma prioridade de 1 significa que o controle nunca será descartado. As outras prioridades válidas são de 2 até 7, e esses controles serão descartados na ordem de seus valores (começando pelos valores mais altos).


Exemplo da propriedade Priority

Este exemplo move o primeiro controle caixa de combinação da barra de comando personalizada chamada "Custom" para a posição anterior ao sétimo controle da barra de comando, define a marcação como "selection box" e, em seguida, atribui ao controle uma alta prioridade para que ele venha a ser removido da barra de comando se os controles não couberem todos em uma linha.

Set allcontrols = CommandBars("Custom").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

            .Tag = "Selection box"

            .Priority = 5

        End With

    Exit For

End If

Next


Propriedade Protection

Retorna ou define a maneira como a barra de comando especificada é protegida contra personalização pelo usuário. Pode ser uma das seguintes constantes MsoBarProtection ou uma soma delas: msoBarNoProtection, msoBarNoCustomize, msoBarNoResize, msoBarNoMove, msoBarNoChangeVisible, msoBarNoChangeDock, msoBarNoVerticalDock ou msoBarNoHorizontalDock. Long de leitura e gravação.


Exemplo da propriedade Protection

Este exemplo percorre a coleção de barras de comando para localizar a barra de comando chamada "Forms". Se essa barra de comando for localizada, o exemplo a tornará visível e protegerá seu estado de ancoragem.

foundFlag = False

For i = 1 To .CommandBars.Count

    If .CommandBars(i).Name = "Forms" Then

            .CommandBars(i).Protection = msoBarNoChangeDock

            .CommandBars(i).Visible = True

            foundFlag = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Forms' command bar is not in the collection."

End If


Método ReleaseFocus

Libera o foco da interface do usuário de todas as barras de comando.

Sintaxe

expressão.ReleaseFocus

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBars.


Exemplo do método ReleaseFocus

Este exemplo libera o foco da interface do usuário de todas as barras de comando.

CommandBars.ReleaseFocus


Método RemoveItem

Remove um item de lista do controle caixa de combinação da barra de comando especificada.

Observação   A propriedade falha quando aplicada a controles que não sejam controles de lista.

Sintaxe

expressão.RemoveItem(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarComboBox.

Index   Long obrigatório. O item a ser removido da lista.


Exemplo do método RemoveItem

O exemplo seguinte determina se existem mais de três itens no controle caixa de combinação chamado "Combo1" na barra de comando personalizada chamada "Custom". Se houver mais de três itens, o exemplo removerá o segundo item, alterará o estilo para não mostrar o rótulo da caixa de combinação e definirá um novo valor. Ele também define a propriedade Tag do objeto pai (o objeto CommandBarControl) para mostrar que a lista foi alterada.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls("Combo1")

With myControl

    If .ListCount > 3 Then

        .RemoveItem 2

        .Style = msoComboNormal

        .Text = "New Default"

         Set ctrl = .Parent

         ctrl.Tag = "Contents Changed"

    End If

End With


Método Reset

Redefine a barra de comando interna especificada para sua configuração de controles padrão, ou redefine o controle de barra de comando interno especificado para sua função e face padrão.

Sintaxe

expressão.Reset

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBar, CommandBarControl, CommandBarButton, CommandBarPopup, ou CommandBarComboBox.

Comentários

A redefinição de um controle interno restaura as ações originalmente pretendidas para o controle e redefine cada uma das propriedades de controle de volta a seu estado original. A redefinição de uma barra de comando interna remove os controles personalizados e restaura os controles internos.


Exemplo do método Reset

Este exemplo usa o valor de user para ajustar as barras de comando conforme o nível do usuário. Se user for "Level 1", a barra de comando chamada "Custom" será exibida. Se user for qualquer outro valor, a barra de comando interna Visual Basic será redefinida para seu estado padrão e a barra de comando chamada "Custom" será desativada.

Set myBar = CommandBars("Custom")

If user = "Level 1" Then

    myBar.Visible = True

Else

    .CommandBars("Visual Basic").Reset

    myBar.Enabled = False

End If


Propriedade RowIndex

Retorna ou define a ordem de ancoragem da barra de comando especificada em relação a outras barras de comando na mesma área de ancoragem. Pode ser um número inteiro maior que zero ou uma das seguintes constantes msoBarRow: msoBarRowFirst ou msoBarRowLast. Long de leitura e gravação.

Comentários

As barras de comando com números menores são ancoradas primeiro. Várias barras de comando podem compartilhar o mesmo índice de linha. Se duas ou mais barras de comando compartilharem o mesmo índice de linha, a barra de comando atribuída mais recentemente será exibida primeiro nesse grupo.


Exemplo da propriedade RowIndex

Este exemplo ajusta a posição da barra de comando chamada "Custom" movendo-a para a esquerda 110 pixels mais que o padrão, e torna essa barra de comando a primeira a ser ancorada alterando seu índice de linha para 1.

Set myBar = CommandBars("Custom")

With myBar

    .RowIndex = 1

    .Left = 140

End With


Método ShowPopup

Exibe a barra de comando especificada como um menu de atalho nas coordenadas especificadas ou nas atuais coordenadas do ponteiro.

Observação   Se a propriedade Position da barra de comando não estiver definida como msoBarPopup, este método falhará.

Sintaxe

expressão.ShowPopup(x, y)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBar.

x   Variant opcional. A coordenada x do local do menu de atalho. Se esse argumento for omitido, a coordenada x atual do ponteiro será usada.

y   Variant opcional. A coordenada y do local do menu de atalho. Se esse argumento for omitido, a coordenada y atual do ponteiro será usada.


Exemplo do método ShowPopup

Este exemplo cria um menu de atalho contendo dois controles. O método ShowPopup é usado para que seja visualizada a tecla de atalho.

Set myBar = CommandBars _

    .Add(Name:="Custom1", Position:=msoBarPopup, Temporary:=False)

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls.Add Type:=msoControlComboBox

End With

myBar.ShowPopup


Propriedade State

Retorna ou define a aparência do controle de botão da barra de comando especificada. Pode ser uma das seguintes constantes MsoButtonState: msoButtonUp, msoButtonDown ou msoButtonMixed. Long de leitura e gravação.


Exemplo da propriedade State

Este exemplo determina se o primeiro controle da barra de comando chamada "Custom" possui uma face de botão interno. Se possuir, o exemplo copiará a face de botão para a Área de transferência para que ela possa ser personalizada com um aplicativo tal como o Microsoft Paint. Em seguida, o exemplo define o estado do botão como msoButtonUp.

Set myControl = CommandBars("Custom").Controls(1)

With myControl

    If .BuiltInFace = True Then

        .CopyFace

    End If

    .State = msoButtonUp

End With


Propriedade Style

Objeto CommandBarButton: Retorna ou define a maneira como o controle de botão de barra de comando especificado é exibido. Pode ser uma das seguintes constantes MsoButtonStyle: msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption. Long de leitura e gravação.

Objeto CommandBarComboBox: Retorna ou define a maneira como o controle caixa de combinação de barra de comando especificado é exibido. Pode ser uma das seguintes constantes MsoComboStyle: msoComboLabel ou msoComboNormal. Long de leitura e gravação.


Exemplo da propriedade Style

Este exemplo cria um menu de atalho contendo um controle de botão e um controle caixa de combinação e define o estilo de cada um.

Set myBar = CommandBars _

    .Add(Name:="Custom1", Position:=msoBarPopup, Temporary:=False)

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls(1).Style = msoButtonCaption

    .Controls.Add Type:=msoControlComboBox

    With .Controls(2)

        .Style = msoComboLabel

        .AddItem "vanilla"

        .AddItem "chocolate"

        .AddItem "cookie dough"

    End With

End With

myBar.ShowPopup


Propriedade Tag

Retorna ou define informações sobre o controle de barra de comando, tais como dados que podem ser usados como argumento em procedimentos, ou informações que identifiquem o controle. String de leitura e gravação.


Exemplo da propriedade Tag

Este exemplo move o primeiro controle caixa de combinação da barra de comando personalizada chamada "My Custom Bar" para a posição anterior ao sétimo controle da barra de comando, define a marcação como "selection box" e atribui ao controle uma prioridade alta para que ele venha a ser descartado da barra de comando caso os controles não caibam todos em uma linha.

Set allControls = CommandBars("My Custom Bar").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

            .Tag = "Selection box"

            .Priority = 5

        End With

        Exit For

    End If

Next


Propriedade TooltipText

Retorna ou define o texto exibido na dica de tela do controle de barra de comando especificado. String de leitura e gravação.

Comentários

Por padrão, o valor da propriedade Caption é usado como dica de tela.


Exemplo da propriedade TooltipText

Este exemplo define o último controle da barra de menu ativa para iniciar seu próprio grupo e, em seguida, adiciona uma dica de tela a ele.

Set myMenuBar = CommandBars.ActiveMenuBar

Set lastCtrl = myMenuBar _

   .Controls(myMenuBar.Controls.Count)

lastCtrl.BeginGroup = True

lastCtrl.TooltipText = "Click for help on UI feature"

End With


Propriedade ActiveMenuBar

Retorna um objeto CommandBar representando a barra de menu ativa no aplicativo recipiente. Somente para leitura.


Exemplo da propriedade ActiveMenuBar

Este exemplo adiciona um controle pop-up temporário chamado "Custom" ao final da barra de menu ativa e, em seguida, adiciona um controle de botão chamado "Import" à barra de comando exibida pelo controle.

Set myMenuBar = CommandBars.ActiveMenuBar

Set newMenu = myMenuBar.Controls.Add(Type:=msoControlPopup, Temporary:=True)

newMenu.Caption = "Custom"

Set ctrl1 = newMenu.CommandBar.Controls _

    .Add(Type:=msoControlButton, Id:=1)

With ctrl1

    .Caption = "Import"

    .TooltipText = "Import"

    .Style = msoButtonCaption

End With


Método AddItem

Adiciona um item de lista ao controle caixa de combinação de barra de comando especificado. O controle caixa de combinação precisa ser um controle personalizado e precisa ser uma caixa de combinação ou uma caixa de listagem drop-down.

Observação   Este método irá falhar se for aplicado a um controle caixa de combinação que seja uma caixa de edição ou um controle caixa de combinação interno.

Sintaxe

expressão.AddItem(Text, Index)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarComboBox.

Text   String obrigatória. O item a ser adicionado ao controle especificado.

Index   Variant opcional. A posição do item especificado na lista de itens. Se esse argumento for omitido, o item será adicionado ao final da lista.


Exemplo do método AddItem

Este exemplo adiciona um controle caixa de combinação à barra de comando chamada "Custom" e, em seguida, adiciona dois itens à lista. O exemplo também define o número de itens de linha, a largura da caixa de combinação e um padrão em branco para a caixa de combinação.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


Propriedade BeginGroup

True se o controle de barra de comando especificado está no início de um grupo de controles na barra de comando. Boolean de leitura e gravação.


Exemplo da propriedade BeginGroup

Este exemplo define o último controle da barra de menu ativa para ficar no início de seu próprio grupo.

Set myMenuBar = CommandBars.ActiveMenuBar

Set lastMenu = myMenuBar _

    .Controls(myMenuBar.Controls.Count)

lastMenu.BeginGroup = True


Propriedade BuiltIn

True se a barra de comando ou o controle de barra de comando especificado é uma barra de comando ou controle interno do aplicativo recipiente. False se for um controle ou barra de comando personalizada, ou se for um controle interno cuja propriedade OnAction tenha sido definida. Boolean somente para leitura.


Exemplo da propriedade BuiltIn

Este exemplo exclui todas as barras de comando personalizadas que não estejam visíveis.

foundFlag = False

deletedBars = 0

For Each bar In CommandBars

    If (bar.BuiltIn = False) And (bar.Visible = False) Then

        bar.Delete

        foundFlag = True

        deletedBars = deletedBars + 1

    End If

Next

If Not foundFlag Then

    MsgBox "No command bars have been deleted."

Else

    MsgBox deletedBars & " custom command bar(s) deleted."

End If


Propriedade BuiltInFace

True se a face do controle de botão da barra de comando especificada tem sua face interna. Essa propriedade só pode ser definida como True, o que redefine a face com a face interna. Boolean de leitura e gravação.


Exemplo da propriedade BuiltInFace

Este exemplo determina se a face do primeiro controle da barra de comando chamada "My Custom Bar" é sua face de botão interna. Se for, o exemplo copiará a face do botão para a Área de transferência.

Set myControl = CommandBars("My Custom Bar").Controls(1)

With myControl

    If .BuiltInFace = True Then .CopyFace

End With


Propriedade Caption

Retorna ou define o texto de legenda do controle de barra de comando especificado.  String de leitura e gravação.

Observação   A legenda de um controle é também exibida como sua Dica de tela padrão.


Exemplo da propriedade Caption

Este exemplo adiciona um controle de barra de comando com uma face de botão de verificador ortográfico a uma barra de comando personalizada e, em seguida, define a legenda como "Spelling checker".

Set myBar = CommandBars.Add(Name:="Custom", _

Position:=msoBarTop, Temporary:=True)

myBar.Visible = True

Set myControl = myBar.Controls _

.Add(Type:=msoControlButton, Id:=2)

With myControl

    .DescriptionText = "Starts the spelling checker"

    .Caption = "Spelling checker"

End With


Método Clear

Remove todos os itens de lista do controle caixa de combinação de barra de comando especificada (caixa de combinação ou caixa de listagem drop-down) e limpa a caixa de texto (caixa de combinação ou caixa de edição).

Observação   Este método irá falhar se for aplicado a um controle de barra de comando interno.

Sintaxe

expressão.Clear

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarComboBox.


Exemplo do método Clear

Este exemplo verifica o número de itens do controle caixa de combinação chamado "Names" na barra de comando chamada "Custom Bar". Se houver mais de três itens na lista, o exemplo limpará a lista, adicionará um novo primeiro item à lista e exibirá esse novo item como padrão para o controle caixa de combinação.

Set myBar = CommandBars("Custom Bar")

Set myControl = myBar.Controls("Names")

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem Text:="Bendel", Index:=1

        .ListIndex = 1

    End If

End With


Propriedade CommandBar

Retorna um objeto CommandBar representando o menu exibido pelo controle pop-up especificado. Somente para leitura.


Exemplo da propriedade CommandBar

Este exemplo define thirdLevel com o quarto controle da barra de comando chamada "Drawing".

Set thirdLevel = CommandBars("Drawing") _

    .Controls(1).CommandBar.Controls(4)


Propriedade Controls

Retorna um objeto CommandBarControls representando todos os controles da barra de comando ou controle popup especificado. Somente para leitura.

Para obter informações sobre como retornar um único membro de uma coleção, consulte Retornar um objeto de uma coleção.


Exemplo da propriedade Controls

Este exemplo adiciona um controle caixa de combinação à barra de comando chamada "Custom" e adiciona dois itens à lista da caixa de combinação. O exemplo também define o número de itens de linha, a largura da caixa de combinação e um padrão em branco para a caixa de combinação.

Set myControl = CommandBars("Custom").Controls _

    .Add(Type:=msoControlComboBox, Before:=1)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem Text:="Second Item", Index:=2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


Método CopyFace

Copia a face do controle de botão da barra de comando especificado para a Área de transferência.

Sintaxe

expressão.CopyFace

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBarButton.

Comentários

Use o método PasteFace para colar o conteúdo da Área de transferência em uma face de botão.


Exemplo do método CopyFace

Este exemplo localiza o botão interno Abrir e copia sua face de botão para a Área de transferência.

Set myControl = CommandBars.FindControl(Type:=msoControlButton, Id:=23)

myControl.CopyFace


Propriedade DescriptionText

Retorna ou define a descrição do controle de barra de comando especificado. A descrição é exibida na barra de status do aplicativo recipiente quando o usuário posiciona o ponteiro sobre um controle da barra de comando. String de leitura e gravação.

Comentários

Nem todos os aplicativos exibem uma barra de status.


Exemplo da propriedade DescriptionText

Este exemplo adiciona um controle de barra de comando com uma face de botão de verificador ortográfico em uma barra de comando personalizada. O exemplo também faz o texto "Starts the spelling checker" aparecer na barra de status sempre que o usuário posicionar o ponteiro sobre o botão.

Set myBar = CommandBars.Add("Custom", msoBarTop, , True)

myBar.Visible = True

Set myControl = myBar.Controls _

.Add(Type:=msoControlButton, Id:=2)

With myControl

    .DescriptionText = "Starts the spelling checker"

    .Caption = "Spelling checker"

End With


Propriedade DisplayTooltips

True se as dicas de tela são exibidas sempre que o usuário posiciona o ponteiro sobre controles de barra de comando.  Boolean de leitura e gravação.

Comentários

A definição da propriedade DisplayTooltips em um aplicativo recipiente afeta imediatamente todas as barras de comando desse aplicativo, em qualquer outro aplicativo do Office 97 sendo executado no momento e em qualquer aplicativo do Office 97 aberto após esse instante, até a propriedade ser definida novamente.


Exemplo da propriedade DisplayTooltips

Este exemplo exibe controles e dicas de tela grandes em todas as barras de comando se a barra de menu chamada "Custom Menu Bar" for a barra de menu ativa.

Set allBars = CommandBars

If allBars.ActiveMenuBar.Name = "Custom Menu Bar" Then

    allBars.LargeButtons = True

    allBars.DisplayTooltips = True

End If


Propriedade DropDownLines

Retorna ou define o número de linhas no controle caixa de combinação de barra de comando especificado. O controle caixa de combinação precisa ser um controle personalizado e precisa ser uma caixa de combinação ou uma caixa de listagem drop-down. Long de leitura e gravação.

Observação   Se essa propriedade for definida para um controle caixa de combinação que seja uma caixa de edição ou um controle caixa de combinação interno, ocorrerá um erro.

Comentários

Se essa propriedade for definida como 0 (zero), o número de linhas no controle será baseado no número de itens da lista.


Exemplo da propriedade DropDownLines

Este exemplo adiciona um controle caixa de combinação à barra de comando chamada "Custom" e, em seguida, adiciona dois itens à lista da caixa de combinação. O exemplo também define o número de itens de linha, a largura da caixa de combinação e um padrão em branco para a caixa de combinação.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


Propriedade DropDownWidth

Retorna ou define a largura (em pixels) da lista do controle caixa de combinação de barra de comando especificado.  Long de leitura e gravação.

Observação   Se essa propriedade for definida para um controle caixa de combinação interno, ocorrerá um erro.

Comentários

Se essa propriedade for definida como  -1, a largura da lista será baseada no comprimento do item mais longo da lista da caixa de combinação. Se essa propriedade for definida como 0, a largura da lista será baseada na largura do controle.


Exemplo da propriedade DropDownWidth

Este exemplo adiciona um controle caixa de combinação à barra de comando chamada "Custom" e, em seguida, adiciona dois itens à lista da caixa de combinação. O exemplo também define o número de itens de linha, a largura da caixa de combinação e um padrão em branco para a caixa de combinação.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


Propriedade Enabled

True se a barra de comando ou controle de barra de comando especificado está ativado. Boolean de leitura e gravação.

Comentários

Para barras de comando, a definição dessa propriedade como True faz com que o nome da barra de comando apareça na lista de barras de comando disponíveis.

Para controles internos, se você definir a propriedade Enabled como True, o aplicativo determinará seu estado, mas sua definição como False irá forçá-lo a ser desativado.


Exemplo da propriedade Enabled

Este exemplo ajusta as barras de comando conforme o nível de usuário especificado por user. Se user for "Level 1", a barra de comando chamada "VB Custom Bar" será exibida. Se user for qualquer outro valor, a barra de comando interna "Visual Basic" será redefinida para seu estado padrão e a barra de comando chamada "VB Custom Bar" será desativada.

Set myBar = CommandBars("VB Custom Bar")

If user = "Level 1" Then

    myBar.Visible = True

Else

    CommandBars("Visual Basic").Reset

    myBar.Enabled = False

End If

Este exemplo adiciona dois botões de barra de comando à barra de comando representada pela variável myBar. O primeiro controle é desativado e aparecerá cinza. O segundo controle é ativado por padrão.

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls(1).Enabled = False

    .Controls.Add Type:=msoControlButton, Id:=3

End With

myBar.Visible = True


Propriedade FaceId

Retorna ou define o número de identificação da face do botão atribuída no momento ao controle de botão da barra de comando especificado.  Long de leitura e gravação.

Comentários

A propriedade FaceId determina o aspecto, mas não a função de um botão de barra de comando. A propriedade Id do objeto CommandBarControl determina a função do botão.

O valor da propriedade FaceId de um botão de barra de comando com uma face personalizada é 0 (zero).


Exemplo da propriedade FaceId

Este exemplo adiciona um botão de barra de comando a uma barra de comando personalizada. Clicar nesse botão é equivalente a clicar no comando Abrir do menu Arquivo porque o número de identificação é 23, apesar do botão ter a mesma face de botão que o botão interno Gráfico. Quando você clica nesse botão, a caixa de diálogo Abrir é exibida.

Set newBar = CommandBars.Add(Name:="Custom2", _

     Position:=msoBarTop, Temporary:=True)

newBar.Visible = True

Set con = newBar.Controls.Add(Type:=msoControlButton, Id:=23)

con.FaceId = 17


Método FindControl

Retorna um objeto CommandBarControl que satisfaz o critério especificado.

Sintaxe

expressão.FindControl(Type, Id, Tag, Visible, Recursive)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBars.

Type   Variant opcional. O tipo de controle pelo qual pesquisar. Pode ser uma das seguintes constantes MsoControlType:

msoControlCustom msoControlButton msoControlEdit msoControlDropdown msoControlComboBox msoControlButtonDropdown msoControlSplitDropdown msoControlGenericDropdown msoControlGraphicCombo msoControlSplitButtonMRUPopup msoControlSplitExpandingGrid	msoControlGraphicDropdown msoControlPopup msoControlGraphicPopup msoControlButtonPopup msoControlGauge msoControlLabel msoControlExpandingGrid msoControlGrid msoControlOCXDropDown msoControlSplitButtonPopup
Id   Variant opcional. O identificador do controle pelo qual pesquisar.

Tag   Variant opcional. O valor de marcação do controle pelo qual pesquisar.

Visible    Variant opcional. True para incluir na pesquisa somente controles de barra de comando visíveis. O valor padrão é False.

Recursive    Boolean opcional. True para incluir na pesquisa a barra de comando e todas as suas sub-barras de comando popup. O valor padrão é False.

Comentários

Se a coleção CommandBars contiver dois ou mais controles que satisfaçam o critério de pesquisa, FindControl retornará o primeiro controle localizado. Se não for localizado nenhum controle que satisfaça o critério, FindControl retornará Nothing. Nenhum dos argumentos do método FindControl tem valor padrão.


Exemplo do método FindControl

Este exemplo adiciona o botão Save ao menu Help na barra de menu. O uso do método FindControl garante que o menu Help será localizado mesmo que o usuário tenha personalizado a barra de menu.

Set helpMenu = CommandBars.FindControl _

    (Type:=msoControlPopup, Id:=helpId)

Set helpMenuDrop = helpMenu.Control.CommandBar

helpMenuDrop.Controls.Add Type:=msoControlButton, Id:=saveId


Propriedade DisplayKeysInTooltips

True se são exibidas teclas de atalho nas dicas de ferramentas para cada controle de barra de comando. Boolean de leitura e gravação.

Comentários

Para exibir teclas de atalho em dicas de ferramentas, você também precisa definir a propriedade DisplayTooltips como True.


Exemplo da propriedade DisplayKeysInTooltips

Este exemplo define as opções de todas as barras de comando no Microsoft Office.

With CommandBars

    .LargeButtons = True

    .DisplayTooltips = True

    .DisplayKeysInTooltips = True

    .MenuAnimationStyle = msoMenuAnimationUnfold

End With


Propriedade MenuAnimationStyle

Retorna ou define a maneira como a barra de comando especificada é animada. Pode ser um dos seguintes tipos de msoMenuAnimation: msoMenuAnimationNone, msoMenuAnimationRandom, msoMenuAnimationUnfold ou msoMenuAnimationSlide. De leitura e gravação.


Exemplo da propriedade MenuAnimationStyle

Este exemplo define as opções de todas as barras de comando no Microsoft Office.

With CommandBars

    .LargeButtons = True

    .DisplayTooltips = True

    .DisplayKeysInTooltips = True

    .MenuAnimationStyle = msoMenuAnimationUnfold

End With


Propriedade ActionControl

Retorna o objeto CommandBarControl cuja propriedade OnAction está definida com o procedimento sendo executado. Se o procedimento sendo executado não tiver sido iniciado por um controle de barra de comando, essa propriedade retornará Nothing. Somente para leitura.


Exemplo da propriedade ActionControl

Este exemplo desativa o controle de barra de comando que inicia o procedimento que está sendo executado enquanto uma seqüência de instruções é executada, e em seguida ativa o controle.

Set theCtrl = CommandBars.ActionControl

theCtrl.Enabled = False

    'insert OnAction process here

theCtrl.Enabled = True


Propriedade Context

Retorna ou define uma seqüência de caracteres que determina onde a barra de comando especificada será salva. A seqüência de caracteres é definida e interpretada pelo aplicativo. String de leitura e gravação.

Comentários

Você só pode definir a propriedade Context para barras de comando personalizadas. Essa propriedade falhará se o aplicativo não reconhecer a seqüência de contexto, ou se o aplicativo não suportar alteração de seqüências de contexto por programa.


Propriedade Type

Objeto DocumentProperty: Retorna ou define o tipo de propriedade de documento. Pode ser uma das seguintes constantes MsoDocProperties: msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber ou msoPropertyTypeString. Somente para leitura para propriedades de documento internas; de leitura e gravação para propriedades de documentos personalizadas.

Objeto CommandBar: Retorna o tipo de barra de comando. Pode ser uma das seguintes constantes MsoBarType: msoBarTypeNormal, msoBarTypeMenuBar ou msoBarTypePopup. Long somente para leitura.

Objeto CommandBarControl: Retorna o tipo de controle de barra de comando. Long somente para leitura.

Pode ser uma das seguintes constantes MsoControlType.

Constante	Tipo de controle
msoControlButton
msoControlButtonDropdown
msoControlButtonPopup
msoControlComboBox
msoControlCustom	Reservado para uso futuro.
msoControlDropdown
msoControlEdit
msoControlExpandingGrid
msoControlGauge
msoControlGenericDropdown	Reservado para uso futuro.
msoControlGraphicCombo
msoControlGraphicDropdown
msoControlGraphicPopup	Reservado para uso futuro.
msoControlGrid
msoControlLabel	Reservado para uso futuro.
msoControlOCXDropDown
msoControlPopup
msoControlSplitButtonMRUPopup
msoControlSplitButtonPopup
msoControlSplitDropdown
msoControlSplitExpandingGrid	Reservado para uso futuro.


Exemplo da propriedade Type

Este exemplo localiza o primeiro controle cujo valor de marcação é "Change this bar". Se o controle com esse valor de marcação for um botão de barra de comando, o exemplo adicionará um novo controle caixa de combinação ao final da barra de comando e alterará o valor da marcação do botão localizado para "Changed".

Set ctrl = CommandBars _

    .FindControl(Tag:="Change this bar")

If ctrl Is Nothing Then Goto notFound

If ctrl.Type = msoControlButton Then

    Set br = ctrl.Parent

br.Controls.Add(Type:=msoControlComboBox)

    ctrl.Tag = "Changed"

End If

Este exemplo exibe o nome, tipo e valor de uma propriedade de documento. Você precisa passar um objeto DocumentProperty válido para o procedimento.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


Propriedade Visible

Objeto CommandBar e CommandBarControl: True se a barra de comando ou controle de barra de comando especificado está visível. Boolean de leitura e gravação.

Objeto Assistant: True se o Assistente do Office está visível. Boolean de leitura e gravação.

Comentários

A propriedade Visible de barras de comando personalizadas recém-criadas é False por padrão.

A propriedade Enabled de uma barra de comando precisar estar definida como True antes que a propriedade Visible seja definida como True.


Exemplo da propriedade Visible

Este exemplo percorre a coleção de barras de comando para localizar a barra de comando Forms . Se a barra de comando Forms for localizada, o exemplo a tornará visível e protegerá seu estado de ancoragem.

foundFlag = False

For Each cmdbar In CommandBars

    If cmdbar.Name = "Forms" Then

        cmdbar.Protection = msoBarNoChangeDock

        cmdbar.Visible = True

        foundFlag = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Forms'command bar is not in the collection."

End If

Este exemplo torna visível o Assistente do Office e define sua animação.

With Application.Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


Propriedade Width

Retorna ou define a largura (em pixels) da barra de comando ou controle de barra de comando especificado.  Long de leitura e gravação.


Exemplo da propriedade Width

Este exemplo adiciona um controle personalizado antes do segundo controle da barra de comando chamada "Custom". O exemplo define a altura do controle personalizado com metade da altura da barra de comando e define sua largura como 50 pixels.

Set myBar = cmdbar.CommandBars("Custom")

barheight = myBar.Height

Set myControl = myBar.Controls _

    .Add(Type:=msoControlComboBox, Id:=4, Before:=2, Temporary:=True)

With myControl

    .Height = barheight / 2

    .Width = 50

End With

myBar.Visible = True


Propriedade Application

Retorna um objeto Application representando o aplicativo recipiente do objeto especificado (você pode usar essa propriedade com um objeto de Automação para retornar o aplicativo recipiente desse objeto). Somente para leitura.


Exemplo da propriedade Application

Este exemplo retorna o aplicativo no qual a barra de comando chamada "Documento" foi criada.

Set Appobj = CommandBars("Document").Application


Propriedade Creator

Retorna o código de quatro caracteres do aplicativo no qual o objeto especificado foi criado. Somente para Macintosh. Long somente leitura.


Propriedade Parent

Retorna o objeto pai do objeto especificado. Somente para leitura.


Exemplo da propriedade Parent

Este exemplo exibe o nome do objeto pai de uma propriedade de documento. Você precisa passar um objeto DocumentProperty válido para o procedimento.

Sub DisplayParent(dp as DocumentProperty)

    MsgBox dp.Parent.Name

End Sub


Propriedade ShortcutText

Retorna ou define o texto da tecla de atalho exibido próximo ao controle de botão especificado quando esse botão aparece em um menu, submenu ou menu de atalho. String de leitura e gravação.

Comentários

Você só pode definir essa propriedade para botões de barra de comando que tenham uma macro OnAction anexada.


Exemplo da propriedade ShortcutText

Este exemplo coloca um botão gráfico na barra de comando chamada "Custom" e atribui uma macro OnAction ao botão, juntamente com uma tecla de atalho e uma legenda.

Set myControl = CommandBars("Custom").Controls _

    .Add(Type:=msoControlButton, Id:= 17)

With myControl

    .OnAction = "MySub"

    .Caption = "Graph Results"

    .Control.ShortcutText = "CTRL+SHIFT+M"

End With


Propriedade Height

Retorna ou define a altura da barra de comando ou controle de barra de comando especificado, em pixels. Long de leitura e gravação.

Comentários

A definição da propriedade Height causará um erro se a barra de comando não estiver em um estado redimensionável (ou seja, se estiver ancorada ou protegida contra redimensionamento).


Exemplo da propriedade Height

Este exemplo adiciona um controle personalizado antes do segundo controle da barra de comando chamada "Custom". O exemplo define a altura do controle com metade da altura da barra de comando e define sua largura como 50 pixels.

Set myBar = cmdbar.CommandBars("Custom")

barHeight = myBar.Height

Set myControl = myBar.Controls _

    .Add(Type:=msoControlComboBox, Before:=2, Temporary:=True)

With myControl

    .Height = barHeight / 2

    .Width = 50

End With

myBar.Visible = True


Propriedade Id

Retorna a identificação do controle de barra de comando interno especificado.  Long somente para leitura.

Comentários

A identificação de um controle determina a ação interna desse controle. O valor da propriedade Id para todos os controles personalizados é 1.


Exemplo da propriedade Id

Este exemplo altera a face do botão do primeiro controle na barra de comando chamada "Custom2" se o valor de identificação do botão for menor que 25.

Set ctrl = CommandBars("Custom2").Controls(1)

With ctrl

    If .Id < 25 Then

        .FaceId = 17

        .Tag = "Changed control"

    End If

End With

O exemplo seguinte altera a legenda de cada controle da barra de ferramentas chamado "Standard" para o valor atual da propriedade Id desse controle.

For Each ctl In CommandBars("Standard").Controls

    ctl.Caption = CStr(ctl.Id)

Next ctl


Propriedade Index

Retorna o número de índice do objeto especificado na coleção. Long somente para leitura.

Comentários

A posição do primeiro controle de barra de comando é 1. Os separadores não são contados na coleção CommandBarControls.


Exemplo da propriedade Index

Este exemplo procura na barra de comando chamada "Custom2" um controle com um valor de identificação de 23. Se tal controle for localizado e o número de índice do controle localizado for maior que 5, o controle será posicionado como primeiro controle na barra de comando.

Set myBar = CommandBars("Custom2")

Set ctrl1 = myBar.FindControl(Id:=23)

If ctrl1.Index > 5 Then

    ctrl1.Move before:=1

End If


Propriedade Item

Retorna um objeto de uma coleção ou retorna texto associado a um objeto.

Item é o membro padrão do objeto ou coleção. Por exemplo, as duas instruções seguintes atribuem, ambas, um objeto CommandBar a cmdBar.

Set cmdBar = CommandBars.Item("Standard")

Set cmdBar = CommandBars("Standard")

As duas instruções seguintes atribuem a lblText o texto do primeiro rótulo do objeto Balloon atribuído a myBalloon.

lblText = myBalloon.Labels(1).Item

lblText = myBalloon.Labels(1)

Selecione um dos objetos seguintes para ver uma descrição detalhada da propriedade Item desse objeto.

Assistant

BalloonCheckboxes

BalloonCheckbox

BalloonLabel

BalloonLabels

CommandBarControls

CommandBars

DocumentProperties

FileFindResults

FoundFiles

PropertyTests


Propriedade Item (coleções CommandBars e CommandBarControls)

Retorna um objeto CommandBar de uma coleção CommandBars, ou retorna um objeto CommandBarControl de uma coleção CommandBarControls. Somente para leitura.

Sintaxe

expressão.Item(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto CommandBars ou CommandBarControls.

Index   Variant obrigatória. O nome ou número de índice do objeto a ser retornado. Observe que você só pode usar números de índice para retornar objetos PropertyTest da coleção PropertyTests.


Propriedade Item (coleção BalloonCheckboxes)

Retorna um objeto BalloonCheckbox de uma coleção BalloonCheckboxes. Somente para leitura.

Sintaxe

expressão.Item(iCbx)

expressão   Uma expressão que retorne um objeto BalloonCheckboxes.

iCbx   Long obrigatório. O número de índice da caixa de seleção a ser retornada.


Propriedade Item (coleção BalloonLabels)

Retorna um objeto BalloonLabel de uma coleção BalloonLabels. Somente para leitura.

Sintaxe

expressão.Item(iLbl)

expressão   Uma expressão que retorne um objeto BalloonLabels.

iLbl   Long obrigatório. O número de índice do rótulo a ser retornado.


Propriedade Item (objetos Assistant, BalloonLabel e BalloonCheckbox)

Retorna o texto associado ao objeto especificado. String somente para leitura.

Sintaxe

expressão.Item

expressão   Obrigatória. Uma expressão que retorne um objeto Assistant, BalloonCheckbox ou BalloonLabel.


Propriedade Item (coleção DocumentProperties)

Retorna um objeto DocumentProperty de uma coleção DocumentProperties. Somente para leitura.

Sintaxe

expressão.Item(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto DocumentProperties.

Index   Variant obrigatória. O nome ou número de índice da propriedade de documento a ser retornada.


Propriedade Item (coleção PropertyTests)

Retorna um objeto PropertyTest de uma coleção PropertyTests. Somente para leitura.

Sintaxe

expressão.Item(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto PropertyTests.

Index   Variant obrigatória. O número de índice do teste de propriedade a ser retornado.


Propriedade Item (objeto FoundFiles)

Retorna um nome de arquivo da lista de nomes de arquivos representada pelo objeto FoundFiles. String somente para leitura.

Sintaxe

expressão.Item(Index)

expressão   Obrigatória. Uma expressão que retorne um objeto FoundFiles.

Index   Variant obrigatória. O número de índice do nome de arquivo a ser retornado.


Propriedade Left

Objeto CommandBar ou CommandBarControl: Retorna ou define a distância (em pixels) da extremidade esquerda da barra de comando ou controle de barra de comando especificado até a extremidade esquerda da tela. Retorna a distância desde o lado esquerdo da área de ancoragem. Long de leitura e gravação para CommandBar, Long somente para leitura para CommandBarControl.

Objeto Assistant: Define ou retorna a posição horizontal da janela do Assistente do Office (em pontos) em relação à tela. Long de leitura e gravação.


Exemplo da propriedade Left

Este exemplo ajusta a posição da barra de comando personalizada chamada "Custom" movendo-a para a esquerda 110 pixels a mais que o padrão. O exemplo também torna essa barra de comando a primeira a ser ancorada alterando o número de índice de linha para 1.

Set myBar = CommandBars("Custom")

With myBar

    .RowIndex = 1

    .Left = 140

End With

Este exemplo exibe o Assistente do Office e o move para a posição especificada.

With Assistant

    .Visible = True

    .Left = 300

    .Top = 300

End With


Método Move

Objeto CommandBarControl: Move o controle de barra de comando especificado para uma barra de comando existente.

Objeto Assistant: Move o Assistente do Office para o local especificado.

Sintaxe 1

expressão.Move(Bar, Before)

Sintaxe 2

expressão.Move(xLeft, yTop)

expressão   Sintaxe 1: Obrigatória. Uma expressão que retorne um objeto CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.

Sintaxe 2: Obrigatória. Uma expressão que retorne um objeto Assistant.

Bar   Variant opcional. Um objeto CommandBar que represente a barra de comando de destino para o controle. Se esse argumento for omitido, o controle será movido para o final da mesma barra de comando (a barra de comando na qual o controle reside no momento).

Before   Variant opcional. Um número que indique a posição para o controle. O controle é inserido antes do controle que ocupa essa posição no momento. Se esse argumento for omitido, o controle será inserido na mesma barra de comando.

xLeft   Integer obrigatório. A posição esquerda da janela do Assistente do Office, em pontos.

yTop   Integer obrigatório. A posição superior da janela do Assistente do Office, em pontos.


Exemplo do método Move

Este exemplo move o primeiro controle caixa de combinação da barra de comando personalizada chamada "Custom" para a posição anterior ao sétimo controle dessa barra de comando. O exemplo define a marcação como "Selection box" e atribui ao controle uma baixa prioridade para que ele venha a ser descartado da barra de comando caso os controles não caibam todos em uma linha.

Set allcontrols = CommandBars("Custom").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

        	   .Tag = "Selection box"

        	   .Priority = 5

         End With

         Exit For

    End If

Next

Este exemplo exibe o Assistente do Office no local especificado e define várias opções antes de torná-lo visível.

With Assistant

    .Reduced = True

    .Move xLeft:= 400, yTop:= 300

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


Propriedade Name

Retorna ou define o nome do objeto especificado. String de leitura e gravação para o objeto CommandBar, String somente para leitura para todos os outros objetos.

Comentários

O nome local de uma barra de comando interna é exibido na barra de título (quando a barra de comando não está ancorada) e na lista de barras de comando disponíveis ¾ sempre que essa lista é exibida no aplicativo recipiente.

Para uma barra de comando interna, a propriedade Name retorna o nome da barra de comando em inglês americano. Use a propriedade NameLocal para retornar o nome localizado.

Se você alterar o valor da propriedade LocalName de uma barra de comando personalizada, o valor de Name também será alterado, e vice-versa.


Exemplo da propriedade Name

Este exemplo procura a barra de comando chamada "Custom" na coleção de barras de comando. Se essa barra de comando for localizada, o exemplo a tornará visível.

foundFlag = False

For Each bar In CommandBars

    If bar.Name = "Custom" Then

        foundFlag = True

        bar.Visible = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Custom' bar isn't in collection."

Else

    MsgBox "'Custom' bar is now visible."

End If

Este exemplo exibe o nome, tipo e valor de uma propriedade de documento. Você precisa passar um objeto DocumentProperty válido para o procedimento.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


Método FindControls

Retorna a coleção CommandBarControls atende aos critérios especificados.

Sintaxe

expressão.FindControls(Type, Id, Tag, Visible)

expressão   Obrigatória. Uma expressão que retorna uma coleção CommandBars.

Type   Variant opcional. O tipo de controle. Pode ser uma das seguintes constantes MsoControlType:

msoControlActiveX msoControlCustom msoControlButton msoControlEdit msoControlDropdown msoControlComboBox msoControlButtonDropdown msoControlSplitDropdown msoControlGenericDropdown msoControlGraphicCombo msoControlSplitButtonMRUPopup msoControlSplitExpandingGrid	msoControlGraphicDropdown msoControlPopup msoControlGraphicPopup msoControlButtonPopup msoControlGauge msoControlLabel msoControlExpandingGrid msoControlGrid msoControlOCXDropDown msoControlSplitButtonPopup msoControlPane
Id   Variant opcional. O identificador do controle.

Tag   Variant opcional. O valor da marca do controle.

Visible    Variant opcional. True para incluir somente controles visíveis da barras de comandos na pesquisa. O valor padrão é False.

Comentários

Se nenhum controle que atenda aos critérios for encontrado, o método FindControls retornará Nothing.


Exemplo do método FindControls

Este exemplo usa o método FindControls para retornar todos os membros da coleção CommandBarControls que possuem ID 18 e exibe (em uma caixa de mensagem) o número de controles que satisfazem aos critérios de pesquisa.

Dim myControls As CommandBarControls

Set myControls = CommandBars.FindControls(Type:=msoControlButton, ID:=18)

MsgBox "There are " & myControls.Count & _

    " controls that meet the search criteria."


Propriedade AdaptiveMenus

True se os menus adaptáveis estiverem ativados. Boolean de leitura e gravação.


Exemplo da propriedade AdaptiveMenus

Este exemplo define três opções para todas as barras de comandos do Microsoft Office, incluindo barras de comandos personalizadas e seus controles.

With CommandBars

    .LargeButtons = True

    .DisplayFonts = True

    .AdaptiveMenus = True

End With


Propriedade DisplayFonts

True se os nomes de fonte na caixa Fonte são exibidos em suas fontes reais. Boolean de leitura e gravação.


Exemplo da propriedade DisplayFonts

Este exemplo define três opções para todas as barras de comandos do Microsoft Office, incluindo barras de comandos personalizadas e seus controles.

With CommandBars

0	    .LargeButtons = True

1	    .DisplayFonts = True

2	    .AdaptiveMenus = True

3	End With


Propriedade IsPriorityDropped

True se o controle estiver solto do menu ou da barra de ferramentas no momento, com base nas estatísticas de uso e no espaço de layout. (Observe que não é a mesma coisa que a visibilidade do controle, definida pela propriedade Visible.) Um controle com Visible definida como True não estará imediatamente visível em um menu ou barra de ferramentas personalizados se IsPriorityDropped for True. Boolean somente leitura.

Comentários

Para determinar quando definir IsPriorityDropped como True para um item de menu específico, o Microsoft Office mantém uma contagem total do número de vezes que o item de menu foi usado e um registro do número de sessões de diferentes aplicativos nos quais o usuário usou outro item de menu do mesmo menu que esse item, sem usar o item de menu específico. Quando esse valor atingir certos valores limites, a contagem será diminuída. Quando a contagem chegar a zero, IsPriorityDropped será definida como True. Os programadores não podem definir o valor de sessão, o valor limite ou a propriedade IsPriorityDropped. No entanto, eles podem usar a propriedade AdaptiveMenus para desativar os menus adaptáveis a menus específicos em um aplicativo.

Para determinar quando definir IsPriorityDropped como True para um controle específico da barra de ferramentas, o Office mantém uma lista da ordem em que todos os controles da barra de ferramentas foram executados pela última vez. Uma barra de ferramentas sempre exibirá tantos controles quantos couberem em seu espaço, começando do controle que foi usado por último para o que foi usado primeiro. Os controles com Priority definida como 1 serão sempre exibidos e, se necessário, a barra de ferramentas será quebrada em linhas para mostrá-los. Os programadores podem usar a propriedade Priority para garantir que controles específicos da barra de ferramentas serão sempre exibidos ou para reposicionar as barras de ferramentas de forma que elas tenham espaço suficiente para exibir todos os controles.

Você pode usar a tabela a seguir para prever o número de sessões para as quais um item de um menu personalizado permanecerá visível antes de a propriedade IsPriorityDropped do item de menu ser definida como True.

Número de usos do controle da barra de comandos	Número de sessões do aplicativo
0, 1	3
2	6
3	9
4, 5	12
6– 8	17
9–13	23
14–24	29
25 ou mais	31


Exemplo da propriedade IsPriorityDropped

Este exemplo verifica a propriedade IsPriorityDropped em busca do primeiro controle na barra de comandos chamada “Custom”. Se IsPriorityDropped for True, o exemplo definirá a propriedade AdaptiveMenus como False, restaurando a barra de comandos solta.

If CommandBars("Custom").Controls(1).IsPriorityDropped Then

    CommandBars.AdaptiveMenus = True

End If


Propriedade HyperlinkType

Define ou retorna o tipo de hyperlink associado ao botão da barra de comandos especificado. Pode ser uma das seguintes constantes MsoCommandBarButtonHyperlinkType: msoCommandBarButtonHyperlinkNone, msoCommandBarButtonHyperlinkOpen ou msoCommandBarButtonHyperlinkInsertPicture. Long de leitura e gravação.


Exemplo da propriedade HyperlinkType

Este exemplo verifica a propriedade HyperlinkType quanto ao botão da barra de comandos chamado “Custom”. Se HyperlinkType estiver definida como msoCommandBarButtonHyperlinkNone, o exemplo definirá a propriedade como msoCommandBarButtonHyperlinkOpen e a URL como www.microsoft.com.

Set myBar = CommandBars _

0	    .Add(Name:="Custom", Position:=msoBarTop, _

1	    Temporary:=True)

2	Set myButton = myBar.Controls.Add(Type:=msoControlButton)

3	With myButton

4	    .FaceId = 277

5	    .HyperlinkType = msoCommandBarButtonHyperlinkNone

6	End With

7	If myButton.HyperlinkType <> _

8	    msoCommandBarButtonHyperlinkOpen Then

9	    myButton.HyperlinkType = _

10	        msoCommandBarButtonHyperlinkOpen

11	    myButton.TooltipText = "www.microsoft.com"

12	End If


Evento Change

Ocorre quando o usuário final altera a seleção em uma caixa de combinação da barra de comandos.

Sintaxe

Private Sub CommandBarComboBox_Change

    (ByVal Ctrl As CommandBarComboBox)

Comentários

O evento Change é reconhecido pelo objeto CommandBarComboBox. Para retornar o evento Change para um determinado controle CommandBarComboBox, use a palavra-chave WithEvents para declarar uma variável e defina a variável como o controle CommandBarComboBox. Quando o evento Change é acionado, executa a macro ou o código que você especificou com a propriedade OnAction do controle.


Exemplo do evento Change

O exemplo a seguir cria uma barra de comandos com um controle CommandBarComboBox contendo quatro seleções. A caixa de combinação responde à interação do usuário através do evento CommandBarComboBox_Change.

Private ctlComboBoxHandler As New ComboBoxHandler

Sub AddComboBox()

    Set HostApp = Application

    Dim newBar As Office.CommandBar

    Set newBar = HostApp.CommandBars.Add(Name:="Test CommandBar", Temporary:=True)

    Dim newCombo As Office.CommandBarComboBox

    Set newCombo = newBar.Controls.Add(msoControlComboBox)

    With newCombo

        .AddItem "First Class", 1

        .AddItem "Business Class", 2

        .AddItem "Coach Class", 3

        .AddItem "Standby", 4

        .DropDownLines = 5

        .DropDownWidth = 75

        .ListHeaderCount = 0

    End With

    ctlComboBoxHandler.SyncBox newCombo

    newBar.Visible = True

End Sub

O exemplo anterior conta com o código a seguir, que é armazenado em um módulo de classe no projeto do VBA.

Private WithEvents ComboBoxEvent As Office.CommandBarComboBox

Public Sub SyncBox(box As Office.CommandBarComboBox)

    Set ComboBoxEvent = box

    If Not box Is Nothing Then

        MsgBox "Synced " & box.Caption & " ComboBox events."

    End If

End Sub

Private Sub Class_Terminate()

    Set ComboBoxEvent = Nothing

End Sub

Private Sub ComboBoxEvent_Change(ByVal Ctrl As Office.CommandBarComboBox)

    Dim stComboText As String

    stComboText = Ctrl.Text

        Select Case stComboText

        Case "First Class"

            FirstClass

        Case "Business Class"

            BusinessClass

        Case "Coach Class"

            CoachClass

        Case "Standby"

            Standby

    End Select

End Sub

Private Sub FirstClass()

    MsgBox "You selected First Class reservations"

End Sub

Private Sub BusinessClass()

    MsgBox "You selected Business Class reservations"

End Sub

Private Sub CoachClass()

    MsgBox "You selected Coach Class reservations"

End Sub

Private Sub Standby()

    MsgBox "You chose to fly standby"

End Sub


Evento Click

Ocorre quando o usuário clica em um objeto CommandBarButton.

Sintaxe

Private Sub CommandBarButton_Click

    (ByVal Ctrl As CommandBarButton,

    ByVal CancelDefault  As Boolean)

A sintaxe do evento Click inclui os dois argumentos descritos na tabela a seguir.

Argumento	Descrição
Ctrl	CommandBarButton obrigatório. Indica o controle CommandBarButton que iniciou o evento.
CancelDefault	Boolean obrigatório. False se ocorrer o comportamento padrão associado ao controle CommandBarButton, a menos que tenha sido cancelado por outro processo ou suplemento.
Comentários

O evento Click é reconhecido pelo objeto CommandBarButton. Para retornar o evento Click para um determinado controle CommandBarButton, use a palavra-chave WithEvents para declarar a variável e defina a variável como o controle.


Exemplo do evento Click

O exemplo a seguir cria um novo botão de barra de comandos no menu Arquivo do aplicativo host que permite ao usuário salvar pastas de trabalho como um arquivo de valores separados por vírgula. (Este exemplo funciona em todos os aplicativos, mas o contexto de salvar como CSV se aplica ao Microsoft Excel.)

Private HostApp As Object

Sub createAndSynch()

    Dim iIndex As Integer

    Dim iCount As Integer

    Dim fBtnExists As Boolean

    Dim obCmdBtn As Object

    On Error GoTo errHandler

    Set HostApp = Application

    Dim barHelp As Office.CommandBar

    Set barHelp = Application.CommandBars("File")

    fBtnExists = False

    iCount = barHelp.Controls.Count

    For iIndex = 1 To iCount

        If barHelp.Controls(iIndex).Caption = "Save As CSV (Comma Delimited)" Then fBtnExists = True

    Next

    Dim btnSaveAsCSV As Office.CommandBarButton

    If fBtnExists Then

        Set btnSaveAsCSV = barHelp.Controls("Save As CSV (Comma Delimited)")

    Else

        Set btnSaveAsCSV = barHelp.Controls.Add(msoControlButton)

        btnSaveAsCSV.Caption = "Save As CSV (Comma Delimited)"

    End If

    btnSaveAsCSV.Tag = "btn1"

    btnSaveAsCSVHandler.SyncButton btnSaveAsCSV

    Exit Sub

errHandler:

    ' Insert error handling code here

End Sub

O exemplo anterior conta com o código a seguir, que é armazenado em um módulo de classe no projeto do VBA.

Private WithEvents ButtonClickEvent As Office.CommandBarButton

Private Sub ButtonClickEvent_Click(ByVal Ctrl As Office.CommandBarButton, _

    CancelDefault As Boolean)

    ActiveWorkbook.SaveAs "MyWorkbook.csv", xlCSV

    CancelDefault = True

End Sub

Public Sub SyncButton(btn As Office.CommandBarButton)

    Set ButtonClickEvent = btn

    If Not btn Is Nothing Then

        MsgBox "Synced '" & btn.Caption & "' button events."

    End If

End Sub

Private Sub Class_Terminate()

    Set ButtonClickEvent = Nothing

End Sub


Evento OnUpdate

Ocorre quando qualquer alteração é feita em uma barra de comandos.

Sintaxe

Private Sub CommandBars_OnUpdate()

Comentários

O evento OnUpdate é reconhecido pelo objeto CommandBar e por todos os controles da barra de comandos. O evento é acionado por qualquer alteração a uma barra de comandos ou controle da barra de comandos ou por qualquer alteração ao estado de uma barra de comandos ou controle da barra de comandos. Essas alterações podem ocorrer devido a uma seleção de texto ou de célula, por exemplo. Como uma grande quantidade de eventos OnUpdate pode ocorrer durante o uso normal, os desenvolvedores devem ter cuidado ao usar esse evento. É extremamente importante que esse evento seja usado, principalmente, para verificar se uma barra de comandos personalizada foi adicionada ou removida por um COMAddIn. Para obter mais informações sobre o uso de eventos com suplementos COM, consulte o capítulo "Suplementos, Modelos, Assistente e Bibliotecas" no Guia do Programador do Office 2000/Visual Basic.


Propriedade AdaptiveMenu

True se um menu personalizado estiver ativado. Boolean de leitura e gravação.


Exemplo da propriedade AdaptiveMenu

Este exemplo define a propriedade AdaptiveMenu como False no menu File do aplicativo do Microsoft Office em que você está trabalhando.

CommandBars("File").AdaptiveMenu = False


barra de comando

Um objeto programável que você pode usar no Visual Basic para controlar um menu ou barra de ferramentas. Todos os itens seguintes são representados por objetos CommandBar:

·	Barras de menu, barras de ferramentas e menus de atalho

·	Menus em barras de menus e barras de ferramentas

·	Submenus em menus, submenus e menus de atalho


controle de barra de comando

Um controle interno ou personalizado em uma barra de menus, barra de ferramentas, menu, submenu ou menu de atalho. Os controles personalizados que você pode adicionar a barras de comando incluem botões, caixas de edição, caixas de listagem drop-down, caixas de combinação e controles pop-up (controles que exibem um menu ou submenu).


controle de botão

Um botão em uma barra de ferramentas ou um item de menu em um menu, submenu ou menu de atalho que executa um comando quando é clicado. Os botões de barras de ferramentas e itens de menu compartilham as mesmas propriedades e métodos.

Em uma barras de ferramentas, um controle de botão só pode ser exibido como um ícone, um ícone e uma legenda ou apenas uma legenda. Em um menu, um controle de botão pode ser exibido como um ícone e uma legenda ou somente como uma legenda.


controle caixa de combinação

Uma caixa de edição, caixa de listagem drop-down ou caixa de combinação personalizada em uma barra de menu, barra de ferramentas, menu, submenu ou menu de atalho. Um controle caixa de combinação personalizado pode ser exibido com ou sem um rótulo. Quando uma barra de ferramentas está ancorada verticalmente, quaisquer controles caixa de combinação personalizados nela contidos não são visíveis.

Muitos controles internos, tais como o botão Desfazer, também são considerados controles caixa de combinação; no entanto, a maioria das propriedades e métodos para modificação de controles caixa de combinação não estão disponíveis para esses controles internos.


controle pop-up

Um controle interno ou personalizado em uma barra de menu ou barra de ferramentas que exibe um menu quando é clicado; ou um item de menu interno ou personalizado em um menu, submenu ou menu de atalho que exibe um submenu quando o ponteiro é posicionado sobre ele.

Muitos controles internos, tais como o botão Cor da fonte, também são considerados controles pop-up; no entanto, a maioria das propriedades e métodos para modificação de controles pop-up não está disponível para esses controles internos.


Objeto da coleção CommandBars

Uma coleção de objetos CommandBar representando as barras de comando do aplicativo recipiente.

Usar a coleção CommandBars

Use a propriedade CommandBars para retornar a coleção CommandBars. O exemplo seguinte exibe na janela Immediate ambos os nomes e o nome local de cada barra de menu e barra de ferramentas, e exibe um valor que indica se a barra de menu ou barra de ferramentas está visível.

For Each cbar in CommandBars

    Debug.Print cbar.Name, cbar.NameLocal, cbar.Visible

Next

Use o método Add para adicionar uma nova barra de comando à coleção. O exemplo seguinte cria uma barra de ferramentas personalizada chamada "Custom1" e a exibe como uma barra de ferramentas flutuante.

Set cbar1 = CommandBars.Add(Name:="Custom1", Position:=msoBarFloating)

cbar1.Visible = True

Use CommandBars(índice), onde índice é o número de índice ou nome de uma barra de comando, para retornar um único objeto CommandBar. O exemplo seguinte ancora a barra de ferramentas chamada "Custom1" na parte inferior da janela do aplicativo.

CommandBars("Custom1").Position = msoBarBottom

Observação   Você pode usar o nome ou o número de índice para especificar uma barra de menu ou barra de ferramentas na lista de barras de menu e barras de ferramentas disponíveis no aplicativo recipiente. Entretanto, você precisa usar o nome para especificar um menu, menu de atalho ou submenu (todos os quais são representados por objetos CommandBar).

Se dois ou mais menus ou submenus personalizados tiverem o mesmo nome, CommandBars(índice) retornará o primeiro. Para garantir que você retorne o menu ou submenu correto, localize o controle pop-up que exibe esse menu. Em seguida, aplique a propriedade CommandBar ao controle pop-up para retornar a barra de comando que representa esse menu.


Objeto CommandBar

Representa uma barra de comando no aplicativo recipiente. O objeto CommandBar é um membro da coleção CommandBars.

Usar o objeto CommandBar

Use CommandBars(índice), onde índice é o número de índice ou nome de uma barra de comando, para retornar um único objeto CommandBar. O exemplo seguinte percorre a coleção de barras de comando para localizar a barra de comando chamada "Forms". Se localizar essa barra de comando, o exemplo a tornará visível e protegerá seu estado de ancoragem. Nesse exemplo, a variável cb representa um objeto CommandBar.

foundFlag = False

For Each cb In CommandBars

    If cb.Name = "Forms" Then

        cb.Protection = msoBarNoChangeDock

        cb.Visible = True

        foundFlag = True

    End If

Next cb

If Not foundFlag Then

    MsgBox "The collection does not contain a Forms command bar."

End If

Você pode usar um nome ou número de índice para especificar uma barra de menu ou barra de ferramentas na lista de barras de menu ou barras de ferramentas disponíveis no aplicativo recipiente. Entretanto, você precisa usar um nome para especificar um menu, menu de atalho ou submenu (todos os quais são representados por objetos CommandBar). Este exemplo adiciona um novo item de menu à parte inferior do menu Ferramentas. Quando clicado, o novo item de menu executa o procedimento chamado "qtrReport".

Set newItem = CommandBars("Tools").Controls.Add(Type:=msoControlButton)

With newItem

    .BeginGroup = True

    .Caption = "Make Report"

    .FaceID = 0

    .OnAction = "qtrReport"

End With

Se dois ou mais menus ou submenus personalizados tiverem o mesmo nome, CommandBars(índice) retornará o primeiro. Para garantir que você retorne o menu ou submenu correto, localize o controle pop-up que exibe esse menu. Em seguida, aplique a propriedade CommandBar ao controle pop-up para retornar a barra de comando que representa esse menu.

Assumindo que o terceiro controle da barra de ferramentas chamada "Custom Tools" seja um controle pop-up, este exemplo adicionará o comando Save à parte inferior desse menu.

Set viewMenu = CommandBars("Custom Tools").Controls(3).CommandBar

viewMenu.Controls.Add ID:=3    'ID of Save command is 3


Objeto da coleção CommandBarControls

Uma coleção de objetos CommandBarControl representando os controles de barra de comando em uma barra de comando.

Usar a coleção CommandBarControls

Use a propriedade Controls para retornar a coleção CommandBarControls. O exemplo seguinte altera a legenda de cada controle da barra de ferramentas chamada "Standard" para o valor atual da propriedade Id para esse controle.

For Each ctl In CommandBars("Standard").Controls

ctl.Caption = CStr(ctl.Id)

Next ctl

Use o método Add para adicionar um novo controle de barra de comando à coleção CommandBarControls. Este exemplo adiciona um novo botão em branco à barra de comando chamada "Custom".

Set myBlankBtn = CommandBars("Custom").Controls.Add

Use Controls(índice), onde índice é a legenda ou o número de índice de um controle, para retornar um objeto CommandBarControl, CommandBarButton, CommandBarComboBox ou CommandBarPopup. O exemplo seguinte copia o primeiro controle da barra de comando chamada "Standard" para a barra de comando chamada "Custom".

Set myCustomBar = CommandBars("Custom")

Set myControl = CommandBars("Standard").Controls(1)

myControl.Copy Bar:=myCustomBar, Before:=1


Objeto CommandBarControl

Representa um controle de barra de comando. O objeto CommandBarControl é um membro da coleção CommandBarControls. As propriedades e método do objeto CommandBarControl são todas compartilhadas pelos objetos CommandBarButton, CommandBarComboBox e CommandBarPopup.

Observação   Ao escrever código do Visual Basic para trabalhar com controles de barra de comando personalizados, você usa os objetos CommandBarButton, CommandBarComboBox e CommandBarPopup. Ao escrever código para trabalhar com controles internos do aplicativo recipiente que não podem ser representados por um desses três objetos, você usa o objeto CommandBarControl.

Usar o objeto CommandBarControl

Use Controls(índice), onde índice é o número de índice de um controle, para retornar um objeto CommandBarControl. (A propriedade Type do controle precisa ser msoControlLabel, msoControlExpandingGrid, msoControlSplitExpandingGrid, msoControlGrid ou msoControlGauge).

Observação   Às variáveis declaradas como CommandBarControl pode se atribuir valores CommandBarButton, CommandBarComboBox e CommandBarPopup.

Você também pode usar o método FindControl para retornar um objeto CommandBarControl. O exemplo seguinte procura por um controle do tipo msoControlGauge; se localizar um, exibirá o número de índice do controle e o nome da barra de comando que o contém. Neste exemplo, a variável lbl representa um objeto CommandBarControl.

Set lbl = CommandBars.FindControl(Type:= msoControlGauge)

If lbl Is Nothing Then

    MsgBox "A control of type msoControlGauge was not found."

Else

    MsgBox "Control " & lbl.Index & " on command bar " _

        & lbl.Parent.Name & " is type msoControlGauge"

End If


Objeto CommandBarButton

Representa um controle de botão em uma barra de comando.

Usar o objeto CommandBarButton

Use Controls(índice), onde índice é o número de índice do controle, para retornar um objeto CommandBarButton. (A propriedade Type do controle precisa ser msoControlButton).

Assumindo que o segundo controle na barra de comando chamada "Custom" seja um botão, o exemplo seguinte altera o estilo desse botão.

Set c = CommandBars("Custom").Controls(2)

With c

If .Type = msoControlButton Then

    If .Style = msoButtonIcon Then

        .Style = msoButtonIconAndCaption

    Else

        .Style = msoButtonIcon

    End If

End If

End With

Você também pode usar o método FindControl para retornar um objeto CommandBarButton.


Objeto CommandBarComboBox

Representa um controle caixa de combinação em uma barra de comando.

Usar o objeto CommandBarComboBox

Use Controls(índice), onde índice é o número de índice do controle, para retornar um objeto CommandBarComboBox. (A propriedade Type do controle precisa ser msoControlEdit, msoControlDropdown, msoControlComboBox, msoControlButtonDropdown, msoControlSplitDropdown, msoControlOCXDropdown, msoControlGraphicCombo ou msoControlGraphicDropdown).

O exemplo seguinte adiciona dois itens ao segundo controle da barra de comando chamada "Custom" e, em seguida, ajusta o tamanho do controle.

Set combo = CommandBars("Custom").Controls(2)

With combo

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListIndex = 0

End With

Você também pode usar o método FindControl para retornar um objeto CommandBarComboBox. O exemplo seguinte pesquisa em todas as barras de comando um objeto CommandBarComboBox visível cuja marcação sheet assignments".

Set myControl = CommandBars.FindControl _

(Type:=msoControlComboBox, Tag:="sheet assignments", Visible:=True)


Objeto CommandBarPopup

Representa um controle pop-up em uma barra de comando.

Usar o objeto CommandBarPopup

Use Controls(índice), onde índice é o número do controle, para retornar um objeto CommandBarPopup. (A propriedade Type do controle precisa ser msoControlPopup, msoControlGraphicPopup, msoControlButtonPopup, msoControlSplitButtonPopup ou msoControlSplitButtonMRUPopup).

Você também pode usar o método FindControl para retornar um objeto CommandBarPopup. O exemplo seguinte pesquisa em todas as barras de comando um objeto CommandBarPopup cuja marcação seja "Graphics".

Set myControl = Application.CommandBars.FindControl _

(Type:=msoControlPopup, Tag:="Graphics")

Comentários

Todo controle pop-up contém um objeto CommandBar. Para retornar a barra de comando de um controle pop-up, aplique a propriedade CommandBar ao objeto CommandBarPopup.


Propriedade FileType

Objeto FileSearch: Retorna ou define o tipo de arquivo a ser pesquisado durante uma pesquisa de arquivos. Pode ser uma das seguintes constantes MsoFileType: msoFileTypeAllFiles, msoFileTypeBinders, msoFileTypeDatabases, msoFileTypeExcelWorkbooks, msoFileTypeOfficeFiles, msoFileTypePowerPointPresentations, msoFileTypeTemplates ou msoFileTypeWordDocuments. O valor padrão é msoFileTypeOfficeFiles. Variant de leitura e gravação.

Objeto FileFind: Retorna ou define o tipo de arquivo a ser pesquisado. Pode ser definido como  um número retornado pela função MacId. Somente para Macintosh. Long de leitura e gravação.

Comentários

Use os argumentos listados na tabela a seguir com a função MacID para retornar o tipo de arquivo para Macintosh adequado.

Tipo de arquivo	Argumento
Documento do Word	MSWD
Pasta de trabalho do Microsoft Excel	XCEL
Apresentação do PowerPoint	PPT3 (para ser usado com todas as versões do PowerPoint)
Arquivo texto	TTXT


Exemplo da propriedade FileType

Este exemplo pesquisa todos os arquivos do Binder localizados na pasta My documents. O exemplo exibe em um diálogo de mensagem o nome e o local de cada arquivo localizado.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileType = msoFileTypeBinders

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " Binder file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no Binder files found."

    End If

End With


Propriedade FoundFiles

Retorna um objeto FoundFiles contendo os nomes de todos os arquivos localizados em uma operação de pesquisa. Somente para leitura.


Exemplo da propriedade FoundFiles

Este exemplo percorre a lista de arquivos localizados e exibe o caminho de cada arquivo.

With Application.FileSearch

For i = 1 To .FoundFiles.Count

    MsgBox .FoundFiles(i)

Next I

End With


Propriedade LastModified

Retorna ou define uma constante que representa a quantidade de tempo desde que o arquivo especificado foi modificado e salvo pela última vez. Pode ser uma das seguintes constantes msoLastModified: msoLastModifiedAnyTime, msoLastModifiedLastMonth, msoLastModifiedLastWeek, msoLastModifiedThisMonth, msoLastModifiedThisWeek, msoLastModifiedToday ou msoLastModifiedYesterday. O valor padrão é msoLastModifiedAnyTime. Variant de leitura e gravação.


Exemplo da propriedade LastModified

Este exemplo define opções para uma pesquisa de arquivos. Os arquivos que essa pesquisa irá retornar foram previamente modificados e estão localizados na pasta C:\:\My Documents ou em uma subpasta dessa pasta.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .LastModified = msoLastModifiedYesterday

End With


Propriedade LookIn

Retorna ou define a pasta a ser pesquisada durante a pesquisa de arquivos especificada. String de leitura e gravação.


Exemplo da propriedade LookIn

Este exemplo pesquisa na pasta My documents todos os arquivos cujos nomes comecem com "Cmd" e exibe o nome e o local de cada arquivo localizado.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd.*"

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

        " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Propriedade MatchAllWordForms

True se a pesquisa de arquivos especificados será expandida para incluir todas as formas da palavra especificada no corpo do arquivo, ou nas propriedades do arquivo. Boolean de leitura e gravação.

Comentários

Essa propriedade só está disponível quando o arquivo Mswds_en.lex tiver sido instalado e registrado. Observe que esse arquivo não é instalado como parte de uma instalação Típica.


Exemplo da propriedade MatchAllWordForms

Este exemplo retorna todos os arquivos que contêm a palavra "run", "running", "runs", ou "ran" no corpo do arquivo ou nas propriedades do arquivo. A propriedade TextOrProperty define a palavra que será coincidida, e limita a pesquisa ao corpo do arquivo ou às propriedades do arquivo.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .TextOrProperty = "run"

    .MatchAllWordForms = True

    .FileType = msoFileTypeAllFiles

End With


Propriedade MatchTextExactly

True se a pesquisa de arquivos especificada só irá localizar arquivos cujo corpo de texto ou propriedades de arquivo contenham a palavra ou frase exata que você especificou. Boolean de leitura e gravação.


Exemplo da propriedade MatchTextExactly

Este exemplo pesquisa na pasta C:\My documents e retorna todos os arquivos que contêm a palavra "Run", seja no corpo do texto ou nas propriedades dos arquivos.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .TextOrProperty = "Run"

    .MatchTextExactly = True

    .FileType = msoFileTypeAllFiles

End With


Método NewSearch

Redefine todas as definições de critério de pesquisa às suas definições padrão.

Sintaxe

expressão.NewSearch

expressão   Obrigatória. Uma expressão que retorne um objeto FileSearch.

Comentários

As definições de critério de pesquisa são retidas ao longo de uma sessão de aplicativo. Use este método toda vez que alterar o critério de pesquisa. Este método não irá redefinir o valor da propriedade LookIn.


Exemplo do método NewSearch

Este exemplo usa o método NewSearch para redefinir o critério de pesquisa padrão antes de iniciar uma nova pesquisa.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "run"

    .MatchAllWordForms = True

    .FileType = msoFileTypeAllFiles

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

        " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Propriedade PropertyTests

Retorna uma coleção PropertyTests representando todos os critérios de pesquisa de uma pesquisa de arquivos. Somente para leitura.

Para obter informações sobre como retornar um único membro de uma coleção, consulte Retornar um objeto de uma coleção.


Exemplo da propriedade PropertyTests

Este exemplo exibe todos os critérios de pesquisa do primeiro teste de propriedade da coleção.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


Propriedade SearchSubFolders

True se a pesquisa especificada inclui todas as subpastas da pasta especificada pela propriedade LookIn. Boolean de leitura e gravação.


Exemplo da propriedade SearchSubFolders

Este exemplo pesquisa na pasta My documents e em todas as suas subpastas todos os arquivos cujos nomes comecem com "Cmd". O exemplo também exibe o nome e o local de cada arquivo localizado.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "cmd*"

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

     " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Propriedade TextOrProperty

Retorna ou define a palavra ou frase a ser pesquisada, seja no corpo de um arquivo ou nas propriedades do arquivo, durante a pesquisa de arquivos especificada. A palavra ou frase pode incluir o caractere curinga * (asterisco) ou ? (ponto de interrogação). String de leitura e gravação.

Comentários

Use o caractere curinga ponto de interrogação para coincidir qualquer único caractere. Por exemplo, digite ?ato para localizar todos os arquivos que contenham pelo menos uma instância de "gato" ou "pato".

Use o caractere curinga asterisco para coincidir qualquer número de caractere. Por exemplo, digite San* para retornar todos os arquivos que contenham pelo menos uma palavra que comece com "San".


Exemplo da propriedade TextOrProperty

Este exemplo pesquisa na pasta C:\My documents e em todas as suas subpastas e retorna todos os arquivos cujo corpo de texto ou propriedades de arquivo tenham quaisquer palavras que comecem com "San". A propriedade TextOrProperty define a palavra a ser pesquisada e limita a pesquisa ao corpo do arquivo ou às propriedades do arquivo.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .TextOrProperty = "San*"

    .FileType = msoFileTypeAllFiles

End With


Propriedade Connector

Retorna o conector entre dois valores de teste de propriedade semelhantes. Pode ser uma das seguintes constantes MsoConnector: msoConnectorAnd ou msoConnectorOr. O valor padrão é msoConnectorAnd. Variant somente para leitura.

Comentários

Um conector especifica se dois critérios de pesquisa semelhantes serão combinados para formar um teste de propriedade (como com msoConnectorAnd) ou tratados independentemente (como com msoConnectorOr).


Exemplo da propriedade Connector

Este exemplo exibe uma mensagem que descreve como o critério de pesquisa será avaliado em uma pesquisa de arquivos.

With Application.FileSearch.PropertyTests(1)

If .Connector = msoConnectorAnd Then

   MsgBox "All search criteria will be combined."

Else

    MsgBox "Criteria will be treated independently"

End If

End With


Propriedade Condition

Retorna a condição do critério de pesquisa especificado. Variant somente para leitura.

Pode ser uma das seguintes constantes MsoCondition:

msoConditionAnyNumberBetween msoConditionAnytime msoConditionAnytimeBetween msoConditionAtLeast msoConditionAtMost msoConditionBeginsWith msoConditionDoesNotEqual msoConditionEndsWith msoConditionEquals msoConditionFileTypeAllFiles msoConditionFileTypeBinders msoConditionFileTypeDatabases msoConditionFileTypeExcelWorkbooks msoConditionFileTypeOfficeFiles msoConditionFileTypePowerPointPresentations msoConditionFileTypeTemplates msoConditionFileTypeWordDocuments msoConditionIncludesNearEachOther msoConditionIncludesPhrase msoConditionInTheLast	msoConditionInTheNext msoConditionIsExactly msoConditionIsNo msoConditionIsNot msoConditionIsYes msoConditionLastMonth msoConditionLastWeek msoConditionLessThan msoConditionMoreThan msoConditionNextMonth msoConditionNextWeek msoConditionOn msoConditionOnorAfter msoConditionOnorBefore msoConditionThisMonth msoConditionThisWeek msoConditionToday msoConditionTomorrow msoConditionYesterday


Exemplo da propriedade Condition

Este exemplo retorna o valor de conexão para critério de pesquisa para o primeiro teste de propriedade.

With Application.FileSearch.PropertyTests(1)

    MsgBox "The condition you've set is: " & .Condition

End With


Propriedade SecondValue

Retorna um teste de propriedade de segundo valor opcional (como em um intervalo) para a pesquisa de arquivo especificada. Variant somente para leitura.

Comentários

Essa propriedade tem o objetivo de ser usada para especificar um intervalo, e só pode ser usada com as constantes MsoCondition msoConditionAnyTimeBetween ou msoConditionAnyNumberBetween.


Exemplo da propriedade SecondValue

Este exemplo exibe o segundo valor do critério de pesquisa (se existir) em uma caixa de diálogo. Se o segundo valor não existir, o exemplo exibirá uma outra mensagem.

With Application.FileSearch.PropertyTests(1)

If .SecondValue = "" Then

   MsgBox "You haven't specified a second value."

Else

    MsgBox "The second value you've set is: " _

    & .SecondValue

End If

End With


Método Remove

Remove um objeto PropertyTest da coleção PropertyTests.

Sintaxe

expressão.Remove(lndex)

expressão   Obrigatória. Uma expressão que retorne um objeto PropertyTests.

lndex   Long obrigatório. O número de índice do teste de propriedade a ser removido.


Exemplo do método Remove

Este exemplo remove o primeiro critério de pesquisa da coleção.

Application.FileSearch.PropertyTests.Remove(1)


Objeto FileSearch

Representa a funcionalidade da caixa de diálogo Abrir (menu Arquivo).

Usar o objeto FileSearch

Use a propriedade FileSearch para retornar o objeto FileSearch. O exemplo seguinte pesquisa os arquivos especificados e exibe tanto o número de arquivos localizados quanto o título de cada arquivo localizado.

With Application.FileSearch

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With

Use o método NewSearch para redefinir o critério de pesquisa com as definições padrão. Todos os valores de propriedade são retidos após cada pesquisa ser executada, e usando o método NewSearch você pode definir propriedades seletivamente para a próxima pesquisa de arquivos sem redefinir manualmente os valores anteriores das propriedades. O exemplo seguinte redefine o critério de pesquisa com definições padrão antes de iniciar uma nova pesquisa.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "Run"

    .MatchTextExactly = True

    .FileType = msoFileTypeAllFiles

End With


Objeto PropertyTest

Representa um único critério de pesquisa de arquivos. Os critérios de pesquisa são listados na caixa de diálogo Localização avançada (menu Arquivo, comando Abrir, botão Localização avançada). O objeto PropertyTest é um membro da coleção PropertyTests.

Usar o objeto PropertyTest

Use PropertyTests(índice), onde índice é o número de índice, para retornar um único objeto PropertyTest. O exemplo seguinte exibe todos os critérios de pesquisa para o primeiro teste de propriedade da coleção PropertyTests.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


Objeto da coleção PropertyTests

Uma coleção de objetos PropertyTest representando todos os critérios de pesquisa de uma pesquisa de arquivos. Os critérios de pesquisa são listados na caixa de diálogo Localização avançada (menu Arquivo, comando Abrir, botão Localização avançada).

Usar a coleção PropertyTests

Use a propriedade PropertyTests para retornar a coleção PropertyTests. O exemplo seguinte exibe o número de critérios de pesquisa de localização avançada que serão utilizados em uma pesquisa de arquivos.

MsgBox Application.FileSearch.PropertyTests.Count

Use o método Add para adicionar um novo objeto PropertyTest à coleção PropertyTests. O exemplo seguinte adiciona dois testes de propriedade aos critérios de pesquisa. O primeiro critério especifica que os arquivos localizados precisam ser documentos do Word, e o segundo especifica que os arquivos localizados precisam ter sido modificados entre 1º de janeiro de 1996 e 30 de junho de 1996.

Set fs = Application.FileSearch

fs.NewSearch

With fs.PropertyTests

    .Add Name:="Files of Type", _

    Condition:=msoConditionFileTypeWordDocuments, _

 Connector:=msoConnectorOr

    .Add Name:="Last Modified", _

    Condition:=msoConditionAnytimeBetween, _

    Value:="1/1/96", SecondValue:="6/30/96", _

    Connector:=msoConnectorAnd

End With

Use PropertyTests(índice), onde índice é o número de índice, para retornar um único objeto PropertyTest. O exemplo seguinte exibe todos os critérios de pesquisa para o primeiro teste de propriedade da coleção PropertyTests.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


Objeto FoundFiles

Representa a lista de arquivos retornados de uma pesquisa de arquivos.

Usar o objeto FoundFiles

Use a propriedade FoundFiles para retornar o objeto FoundFiles. Este exemplo percorre a lista de arquivos localizados e exibe o caminho e o nome de arquivo de cada arquivo localizado.

With Application.FileSearch

    For i = 1 To .FoundFiles.Count

        MsgBox .FoundFiles(i)

    Next I

End With

Use FoundFiles(índice), onde índice é o número de índice, para retornar o caminho e o nome de arquivo de um arquivo localizado. O exemplo seguinte percorre a coleção de arquivos localizados e exibe o caminho e o nome de arquivo de cada um.

With Application.FileSearch

For i = 1 To .FoundFiles.Count

    MsgBox .FoundFiles(i)

Next I

End With

Use o método Execute para iniciar a pesquisa de arquivos e atualizar o objeto FoundFiles. O exemplo seguinte pesquisa na pasta My documents todos os arquivos cujos nomes comecem com "Cmd" e exibe o nome e a localização de cada arquivo localizado. O exemplo seguinte também classifica os arquivos retornados em ordem alfabética crescente por nome de arquivo.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute(SortBy:=msoSortbyFileName, _

    SortOrder:=msoSortOrderAscending) > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


Objeto da coleção DocumentProperties

Uma coleção de objetos DocumentProperty. Cada objeto DocumentProperty representa uma propriedade interna ou personalizada de um documento recipiente.

Usar a coleção DocumentProperties

Use a propriedade BuiltinDocumentProperties para retornar uma coleção DocumentProperties contendo todas as propriedades internas de um documento recipiente. Use a propriedade CustomDocumentProperties para retornar uma coleção DocumentProperties contendo todas as propriedades personalizadas do documento.

Use o método Add para criar uma nova propriedade personalizada e adicioná-la à coleção DocumentProperties. Você não pode usar o método Add para criar uma propriedade interna de documento.

Use BuiltinDocumentProperties(índice), onde índice é o número de índice da propriedade interna do documento, para retornar um único objeto DocumentProperty representando uma propriedade interna específica de documento. Use CustomDocumentProperties(índice), onde índice é o número da propriedade personalizada de documento, para retornar um objeto DocumentProperty representando uma propriedade personalizada específica de documento.


Objeto DocumentProperty

Representa uma propriedade personalizada ou interna de um documento recipiente. O objeto DocumentProperty é um membro da coleção DocumentProperties.

Usar o objeto DocumentProperty

Use BuiltinDocumentProperties(índice), onde índice é o nome ou número de índice da propriedade interna do documento, para retornar um único objeto DocumentProperty representando uma propriedade interna de documento específica. Use CustomDocumentProperties(índice), onde índice é o nome ou número de índice da propriedade personalizada de documento, para retornar um objeto DocumentProperty representando uma propriedade personalizada de documento específica.

Os nomes de todas as propriedades internas do documento disponíveis são mostrados na lista seguinte:

Title Subject Author Keywords Comments Template Last Author Revision Number Application Name Last Print Date Creation Date Last Save Time Total Editing Time Number of Pages	Number of Words Number of Characters Security Category Format Manager Company Number of Bytes Number of Lines Number of Paragraphs Number of Slides Number of Notes Number of Hidden Slides Number of Multimedia Clips
Os aplicativos recipientes não definem necessariamente um valor para cada propriedade interna de documento. Quando um dado aplicativo não define um valor para uma das propriedades internas de documento, retornar a propriedade Value dessa propriedade de documento causa um erro.


Propriedade LinkToContent

True se o valor da propriedade personalizada de documento especificada está vinculado ao conteúdo do documento recipiente. False se o valor é estático. Boolean de leitura e gravação.

Comentários

Essa propriedade só se aplica a propriedades personalizadas de documento. Para propriedades internas de documento, essa propriedade é sempre False.

Use a propriedade LinkSource para definir a origem da propriedade vinculada especificada. A definição da propriedade LinkSource define a propriedade LinkToContent como True.


Exemplo da propriedade LinkToContent

Este exemplo exibe o status de vinculação da propriedade personalizada de documento. Para que o exemplo funcione, dp precisa ser um objeto DocumentProperty válido.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Propriedade LinkSource

Retorna ou define a origem da propriedade personalizada de documento vinculada especificada. String de leitura e gravação.

Comentários

Essa propriedade só se aplica a propriedades personalizadas de documento; você não pode usá-la com propriedades internas de documento.

A origem do vínculo especificado é definida pelo aplicativo recipiente.

A definição da propriedade LinkSource define a propriedade LinkToContent como True.


Exemplo da propriedade LinkSource

Este exemplo exibe o status de vinculado de uma propriedade personalizada de documento. Para que o exemplo funcione, dp precisa ser um objeto DocumentProperty válido.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Propriedade Value

Objeto DocumentProperty: Retorna ou define o valor da propriedade de documento especificada. Variant de leitura e gravação.

Objeto PropertyTest: Retorna o valor de um teste de propriedade para uma pesquisa de arquivos. Variant somente para leitura.

Comentários

Se o aplicativo recipiente não definir um valor para uma das propriedades internas de documento, a leitura da propriedade Value para essa propriedade de documento causará um erro.


Exemplo da propriedade Value

Este exemplo exibe o nome, tipo e valor de uma propriedade de documento. Para que o exemplo funcione, dp precisa ser um objeto DocumentProperty válido.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub

Este exemplo exibe o valor do critério de pesquisa (se existir) em uma caixa de diálogo. Se o segundo valor não existir, o exemplo exibirá uma outra mensagem.

With Application.FileSearch.PropertyTests(1)

If .Value = "" Then

   MsgBox "You haven't specified a value."

Else

    MsgBox "The value you've set is: " _

    & .Value

End If

End With


Propriedade Author

Somente para Macintosh. Retorna ou define uma seqüência (com até 80 caracteres) que representa o autor listado nas propriedades do documento a ser pesquisado. String de leitura e gravação.


Propriedade DateCreatedFrom

Somente para Macintosh. Retorna ou define a data em que o arquivo a ser pesquisado foi criado; esse será o limite mínimo da pesquisa de arquivo. Variant de leitura e gravação.

Comentários

Você pode usar a propriedade DateCreatedTo para definir um limite máximo para a pesquisa de arquivo ou pode omiti-lo para conduzir uma pesquisa de fim aberto.


Propriedade DateCreatedTo

Somente para Macintosh. Retorna ou define a data em que o arquivo a ser pesquisado foi criado; esse será o limite máximo da pesquisa de arquivo. Variant de leitura e gravação.


Propriedade DateSavedFrom

Somente para Macintosh. Retorna ou define a data em que o arquivo a ser pesquisado foi salvo pela última vez; esse será o limite mínimo para a pesquisa de arquivo. Variant de leitura e gravação.

Comentários

Você pode usar a propriedade DateSavedTo para definir um limite máximo para a pesquisa de arquivo ou pode omiti-lo para conduzir uma pesquisa de fim aberto.


Propriedade DateSavedTo

Somente para Macintosh. Retorna ou define a data em que o arquivo a ser pesquisado foi salvo pela última vez; esse será o limite máximo para a pesquisa de arquivo. Variant de leitura e gravação.


Propriedade Keywords

Somente para Macintosh. Retorna ou define uma seqüência (com até 80 caracteres) que representa palavras-chave listadas nas propriedades do documento a ser pesquisado. String de leitura e gravação.


Propriedade ListBy

Somente para Macintosh. Retorna ou define a forma como os arquivos localizados serão exibidos na caixa de diálogo de resultado. Pode ser uma das seguintes constantes msoFileFindListBy: msoFileFindListByName (que lista os arquivos localizados pelo nome de arquivo de sistema) ou msoFileFindListByTitle (que lista os arquivos localizados pela propriedade de título). Leitura e gravação.


Método Load

Somente para Macintosh. Carrega a consulta de pesquisa de arquivo especificada na memória.

Sintaxe

expressão.Load(bstrQueryName)

expressão   Obrigatória. Uma expressão que retorna um objeto FileFind.

bstrQueryName   String obrigatória. Uma seqüência de 31 caracteres ou menos que indica o nome dos critérios de pesquisa a serem carregados.

Comentários

Use o método Execute para executar uma consulta carregada.


Propriedade MatchCase

Somente para Macintosh. True se a pesquisa de arquivo diferenciar maiúsculas de minúsculas. Boolean de leitura e gravação.


Propriedade Options

Somente para Macintosh. Retorna ou define a forma como o grupo mais recente de arquivos localizados é exibido com relação à lista de resultados anteriores. Pode ser uma das seguintes constantes msoFileFindOptions: msoFileFindOptionsNew, msoFileFindOptionsAdd ou msoFileFindOptionsWithin. Variant de leitura e gravação.


Propriedade PatternMatch

True se a pesquisa de arquivos que correspondem à seqüência de caracteres da propriedade Text for expandida para incluir os caracteres curinga * (asterisco) e ? (ponto de interrogação). Somente para Macintosh. Boolean de leitura e gravação.

Comentários

Use o caractere curinga ponto de interrogação para corresponder a um único caractere. Por exemplo, digite gr?y para retornar todos os arquivos que contenham pelo menos uma ocorrência de "gray" ou "grey."

Use o caractere curinga asterisco para corresponder a qualquer número de caracteres. Por exemplo, digite San* para retornar todos os arquivos que contenham pelo menos uma palavra que comece com "San."


Propriedade Results

Somente para Macintosh. Retorna o objeto FileFindResults. Somente leitura.


Método Save

Somente para Macintosh. Salva os critérios da pesquisa de arquivo especificada.

Sintaxe

expressão.Save(bstrQueryName)

expressão Obrigatória. Uma expressão que retorna um objeto FileFind.

bstrQueryName String obrigatória. Uma seqüência (com até 31 caracteres) que indica o nome dos critérios de pesquisa a serem salvos.


Propriedade SavedBy

Somente para Macintosh. Retorna ou define uma seqüência (com até 80 caracteres) que representa o nome do usuário que salvou pela última vez o arquivo a ser pesquisado. String de leitura e gravação.


Propriedade SearchPath

Somente para Macintosh. Retorna ou define a pasta a ser pesquisada durante a pesquisa de arquivo especificada. String de leitura e gravação.

Comentários

O caminho da pesquisa pode ter até 255 caracteres.


Propriedade SelectedFile

Somente para Macintosh. Retorna ou define um número que representa o arquivo realçado na caixa de diálogo Localizar arquivo. Integer de leitura e gravação.

Comentários

Use o método Show para exibir a caixa de diálogo Localizar arquivo.


Propriedade SortBy

Somente para Macintosh. Retorna ou define o método usado para classificar os arquivos retornados pela pesquisa de arquivo especificada. Pode se uma das seguintes constantes msoFileFindSortBy: msoFileFindSortByAuthor, msoFileFindSortByDateCreated, msoFileFindSortByDateSaved, msoFileFindSortByFileName, msoFileFindSortByLastSavedBy, msoFileFindSortBySize ou msoFileFindSortByTitle. Leitura e gravação.


Propriedade SubDir

Somente para Macintosh. True se a pesquisa de arquivo especificada incluir todas as subpastas da pasta especificada pela propriedade SearchPath. Boolean de leitura e gravação.


Propriedade Subject

Somente para Macintosh. Retorna ou define uma seqüência (com até 80 caracteres) que representa o assunto listado nas propriedades do arquivo a ser pesquisado. String de leitura e gravação.


Propriedade Title

Somente para Macintosh. Retorna ou define uma seqüência (com até 80 caracteres) que representa o título do documento nas propriedades do arquivo a ser pesquisado. String de leitura e gravação.


Propriedade View

Somente para Macintosh. Retorna ou define o estilo usado para exibir informações sobre arquivos localizados na caixa de diálogo. Pode ser uma das seguintes constantes msoFileFindView: msoFileFindViewFileInfo, msoFileFindViewPreview ou msoFileFindViewSummary. Variant somente leitura.


Objeto FileFind

Representa a funcionalidade da caixa de diálogo Localizar arquivo.

Usar o objeto FileFind

Use a propriedade FileFind para retornar o objeto FileFind.


Objeto FileFindResults

Representa a lista de arquivos retornada por uma pesquisa de arquivos.

Usar o objeto FileFindResults

Use a propriedade Results para retornar o objeto FileFindResults.

Use FileFindResults(item), onde item é o número de índice, para retornar o caminho e o nome de arquivo de um arquivo localizado.

Use o método Execute para iniciar a pesquisa de arquivos e atualizar a lista.

Use a propriedade View para exibir a lista de arquivos localizados em uma caixa de diálogo.


Visão geral do Assistente do Office

O Microsoft Office 97 introduz um novo tipo de componente de Ajuda: O Assistente do Office. O Assistente do Office, o balão do Assistente do Office e todos os itens dentro do balão são controlados por programa através dos objetos, propriedades e métodos do objeto Assistant.

A ilustração seguinte mostra o Assistente do Office, o balão do Assistente do Office e todos os objetos programáveis dentro do balão.

Para obter informações sobre como você pode fazer alterações em tempo de criação e em tempo de execução no Assistente do Office, consulte os tópicos seguintes.

Usar o Assistente do Office

Criar e modificar balões

Fazer modificações em tempo de execução nos balões


Usar o Assistente do Office

Você pode usar o Assistente do Office em seu aplicativo para oferecer ajuda em áreas específicas, e você pode usar os controles do balão do Assistente do Office para executar os seus próprios procedimentos.

Tudo o que está associado ao Assistente do Office é representado no Visual Basic pelo objeto Assistant e os objetos que ele contém. Muitas das alterações que você faz no Assistente em tempo de execução são as mesmas alterações que você faz em tempo de criação clicando com o botão direito no Assistente. Cada uma das opções listadas na guia Opções da caixa de diálogo Assistente do Office corresponde a uma propriedade do Assistente que você pode definir em tempo de execução. As propriedades listadas na tabela seguinte costumam ser usadas para modificar o Assistente do Office.

Propriedade	Descrição
Animation	Anima o Assistente do Office. Algumas animações são contínuas, outras ocorrem apenas uma vez.
FileName	Especifica o nome de arquivo para o Assistente do Office, completo, com extensão .act. Por exemplo, o nome de arquivo do Assistente do Office Clip é Clippit.act.
Name	Retorna o nome do Assistente do Office. Se você deseja manter controle sobre qual Assistente do Office o usuário selecionou, use essa propriedade.
Visible	Especifica se o Assistente está visível ou oculto.
O exemplo seguinte seleciona William como Assistente do Office, torna o Assistente visível e define uma animação. O exemplo seguinte também define várias propriedades de Ajuda personalizadas que estão disponíveis na guia Opções da caixa de diálogo Assistente do Office em tempo de criação.

With Assistant

    .FileName = "Will.act"

    .Animation = msoAnimationBeginSpeaking

    .AssistWithHelp = True

    .GuessHelp = True

    .FeatureTips = False

    .Visible = True

End With

Existem nove atores diferentes do Assistente do Office que você pode escolher para instalar com o Microsoft Office. Somente um ator do Assistente pode estar ativo em um dado instante. Você pode permitir que o usuário selecione o Assistente em tempo de criação, ou pode selecionar um Assistente para o usuário em tempo de execução. Você não pode modificar os arquivos de atores do Assistente instalados, e você não pode substituir os arquivos fornecidos pelo seu próprio arquivo de ator.


Criar e modificar balões

Você usa o balão do Assistente do Office para fornecer informações para o usuário. As informações dentro do balão podem ser uma simples mensagem, uma solicitação para maiores informações ou uma lista de escolhas para o usuário. As alterações que você faz no balão do Assistente do Office precisam ser feitas em tempo de execução.

A tabela seguinte contém as propriedades e métodos mais habitualmente usados para alteração da aparência ou do funcionamento de um balão recentemente criado (vazio) ou de um balão existente. As alterações feitas em qualquer balão aparecerão na próxima vez que o método Show for usado.

Propriedade ou método	Descrição
Heading	Especifica o texto em negrito que aparece na parte superior do balão do Assistente do Office.
Text	Especifica o texto que aparece no corpo do balão do Assistente do Office. Esse texto aparece após o título, mas antes de quaisquer caixas de seleção, rótulo ou botões.
Labels	Retorna a coleção de rótulos do balão. O formato dos rótulos é determinado pela propriedade BalloonType. Os rótulos aparecem após o texto do balão. A lista de rótulos pode ser numerada ou com marcadores, ou pode ser uma lista de botões. Ao contrário das caixas de seleção, a escolha do usuário é registrada assim que um botão é clicado.
Checkboxes	Retorna a coleção de caixas de seleção no balão. O usuário clica na caixa de seleção e, em seguida, clica no botão apropriado na parte inferior do balão (por exemplo, OK ou Próximo) para registrar sua escolha.
Close	Fecha e despede um balão não modal, mas não libera a variável de objeto. A variável de objeto atribuída ao balão ainda é válida ¾ você pode exibi-la novamente, ou você pode modificá-la e exibi-la posteriormente. Você só pode usar esse método em balões não modais.
Show	Exibe o balão e todos os objetos dentro dele para o usuário. Use esse método somente para objetos Balloon; use a propriedade Visible para o objeto Assistant.
O exemplo seguinte cria um balão que ajuda o usuário a selecionar uma impressora. O exemplo oferece uma opção de caixa de seleção para usuários que queiram pular as informações do balão.

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    lblTxt = "From the File menu, choose Print."

    .Labels(1).Text = lblTxt

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .Checkboxes(1).Text = "Skip this information."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModal

    .Button = msoButtonSetOK

    .Show

End With

Criar balões

Para criar um novo balão, use a propriedade NewBalloon do objeto Assistant. O balão criado estará em branco. Use a propriedade Heading para adicionar um título, use a propriedade Text para adicionar texto ao corpo do balão e, em seguida, adicionar controles, se necessário. Finalmente, use o método Show para exibir o balão. O método Show mostrará o balão tal como este aparece no momento; portanto, é importante usar este método após definir todas as outras propriedades do balão. O exemplo seguinte cria um novo balão, define o título e o corpo do texto e cria três controles caixa de seleção que o usuário pode selecionar.

With Assistant.NewBalloon

    .Button = msoButtonSetOkCancel

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With

Gerenciar vários balões

O Assistente do Office não tem uma coleção Balloons. Para manipular vários balões, você pode definir uma variável de objeto separada para cada balão que você crie e referir-se à variável conforme necessário. Ou você pode criar uma matriz de variáveis de objeto Balloon e atribuir um balão a cada uma. O exemplo seguinte cria uma matriz e adiciona três objetos Balloon em branco à matriz.

Dim myBalloonArray(3) As Balloon

With Assistant

    For i = 1 To 3

        Set myBalloonArray(i) = .NewBalloon

    Next

End With


Fazer modificações em tempo de execução nos balões

Após criar um balão para o Assistente do Office, você pode personalizá-lo adicionando bitmaps, ícones ou metarquivos do Windows ao título ou texto do balão. Você talvez queira adicionar controles tais como caixas de seleção ou botões a seu balão de maneira a poder responder ao usuário quando este clicar em um item do balão.

Adicionar ícones e bitmaps a balões

Para personalizar o seu aplicativo, você pode adicionar ícones e bitmaps aos balões do Assistente do Office. Para adicionar um ícone, atribua uma constante MsoIconType à propriedade Icon do objeto Balloon. Para adicionar um bitmap ou um metarquivo do Windows ao texto de um balão de Assistente do Office, especifique o tipo, a localização e o fator de dimensionamento (se aplicável) ao definir a propriedade Text de um título, texto, caixa de seleção ou rótulo. O exemplo seguinte insere um arquivo bitmap do Windows no texto de um balão.

myBmp = "{bmp c:\windows\circles.bmp}"

myText1 = "This is before the picture, "

myText2 = " and this is after the picture"

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Bitmap."

    .Text = myText1 & myBmp & myText2

    .Show

End With

Adicionar controles a balões

Existem dois tipos de controles que você pode adicionar a um balão: caixas de seleção e botões. Existem cinco caixas de seleção no balão quando ele é criado; você pode tornar qualquer delas visível especificando texto para o controle. Existem também cinco botões de rótulo no balão (se o tipo do balão for msoBalloonTypeButtons), e você pode expor qualquer um deles da mesma maneira que você faria com uma caixa de seleção. Se você tentar adicionar mais de cinco caixas de seleção ou cinco botões de rótulo a um balão, ocorrerá um erro.

Você pode alterar a aparência de qualquer controle em um balão alterando a propriedade Text do controle. Você pode alterar a funcionalidade de uma caixa de seleção ou de um botão em um balão especificando um outro procedimento que será executado sempre que a caixa de seleção ou botão for selecionado (clicado).

O exemplo seguinte cria um balão com um título, texto e três escolhas de região. Quando o usuário seleciona uma caixa de seleção e, em seguida, clica em OK, o procedimento apropriado é executado.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


Visão geral das barras de comando

No Microsoft Office 97, as barras de ferramentas, barras de menu e menus de atalho são todos controlados por programa como um tipo de objeto: barras de comando. Todos os itens seguintes são representados no Visual Basic por objetos CommandBar:

·	Barras de menu, barras de ferramentas e menus de atalho

·	Menus em barras de menu e barras de ferramentas

·	Submenus em menus, submenus e menus de atalho

Você pode modificar qualquer barra de menu ou barra de ferramentas interna, e você pode criar e modificar barras de ferramentas, barras de menu e menus de atalho personalizados para distribuir com seu aplicativo em Visual Basic. Você apresenta os recursos de seu aplicativo como botões individuais em barras de ferramentas ou como grupos de nomes de comando em menus. Como tanto as barras de ferramentas quanto os menus são barras de comando, você usa o mesmo tipo de controle em ambos. Por exemplo, a barra de ferramentas ancorada mostrada na ilustração seguinte contém três botões.

O menu mostrado na ilustração seguinte contém os mesmos três comandos que na ilustração anterior, mas aqui eles são exibidos como itens de menu.

No Microsoft Office 97, as barras de menu e barras de ferramentas podem ambas conter menus. A barra de ferramentas flutuante mostrada na ilustração seguinte contém três botões, e também contém um menu com os mesmos três comandos exibidos como itens de menu.

No Visual Basic, os botões e itens de menu são representados por objetos CommandBarButton. Os controles pop-up que exibem menus e submenus são representados por objetos CommandBarPopup. Na ilustração seguinte, o controle chamado "Menu" e o controle chamado "Submenu" são ambos controles pop-up que exibem um menu e submenu, respectivamente. Ambos o menu e o submenu são objetos CommandBar exclusivos, com seus próprios conjuntos de controles.

No Microsoft Office 97, você também adiciona caixas de texto, caixas de listagem drop-down e caixas de combinação a qualquer barra de comando. Esses três tipos de controles são todos representados no Visual Basic por objetos CommandBarComboBox.

Observação   Embora compartilhem uma aparência e um comportamento semelhantes, os controles de barra de comando e os controles ActiveX não são a mesma coisa. Você não pode adicionar controles ActiveX a barras de comando, e não pode adicionar controles de barra de comando a documentos ou formulários.

Os controles de barra de comando internos em aplicativos recipientes também são representados no Visual Basic por objetos CommandBarButton, CommandBarPopup e CommandBarComboBox, apesar de sua aparência e comportamento poder ser mais complexa que os controles que você mesmo pode adicionar. Embora você possa modificar a localização e a aparência dos controles internos, você não pode modificar seu comportamento interno. Você pode, porém, atribuir uma macro personalizada a qualquer controle interno para substituir completamente o seu comportamento interno.


Usar barras de comando

Em geral, para criar ou modificar barras de ferramentas, barras de menu e menus de atalho que você queira distribuir com seu aplicativo do Visual Basic, você deve usar os recursos de personalização do aplicativo recipiente. Alterações feitas em barras de ferramentas, barras de menu e menus de atalho pelo uso do recurso do aplicativo recipiente são conhecidas como alterações "em tempo de criação". Para obter informações sobre como usar o aplicativo recipiente para fazer alterações em tempo de criação, consulte a Ajuda on-line desse aplicativo.

Você pode adicionar e modificar barras de ferramentas, barras de menu e menus de atalho (e suas partes componentes) usando a parte CommandBars do modelo de objetos do Microsoft Office em código do Visual Basic. Você pode escrever código que seja executado uma vez para criar barras de ferramentas e barras de menu; com efeito, o código simula a implementação de alterações em tempo de criação. Em alguns aplicativos recipientes, porém, pode ser necessário que você use uma combinação desse tipo de código do Visual Basic e a interface de personalização para criar o seu aplicativo do Visual Basic. Seguem algumas áreas comuns onde você precisa usar uma combinação de código e a interface do aplicativo recipiente:

·	Se o seu aplicativo recipiente não fornece uma interface para adicionar ou modificar caixas de edição, caixas de listagem drop-down ou caixas de combinação em barras de ferramentas, você precisará usar código do Visual Basic para adicionar e criar um desses controles.

·	Se o seu aplicativo recipiente oferece uma interface para criação de barras de ferramentas mas não oferece uma para criação de uma nova barra de menu, você terá que criar uma barra de menu usando o Visual Basic. Após ter criado a barra de menu no Visual Basic, você pode criar menus nessa barra de menu usando a interface do aplicativo recipiente.

·	Se o seu aplicativo recipiente não oferece uma maneira de exibir menus de atalho personalizados enquanto a interface de personalização está sendo exibida, você terá que usar código do Visual Basic para modificar esses menus de atalho.

Você também pode escrever código que existe em seu aplicativo do Visual Basic para fazer alterações em barras de ferramentas e barras de menu enquanto o seu aplicativo está sendo executado (por exemplo, você pode escrever código para desativar um comando em uma barra de menu sob certas circunstâncias, ou para adicionar botões a uma barra de ferramentas em resposta a ações de um usuário). Alterações efetuadas por seu código enquanto o seu aplicativo do Visual Basic está sendo executado são conhecidas como alterações "em tempo de execução".

Os tópicos seguintes oferecem informações sobre como você pode fazer alterações em tempo de execução e em tempo de criação em barras de ferramentas e barras de menu a partir de seu código Visual Basic.

Adicionar e modificar barras de ferramentas

Adicionar e manipular barras de menu e itens de menu

Adicionar e exibir menus de atalho


Adicionar e modificar barras de ferramentas

Todos os aplicativos host têm uma interface extensiva para acréscimo e criação de barras de ferramentas personalizadas (acréscimo de botões internos, acréscimo de macros como botões e até acréscimo de controles pop-up a barras de ferramentas). As alterações em tempo de criação que você normalmente fará a partir de código do Visual Basic são aquelas que adicionam ou modificam controles caixa de combinação. Para isso, o trabalho com barras de ferramentas em código é quase que totalmente limitado a implementação de alterações em tempo de execução (alteração do estado de um botão, alteração da aparência de um botão, alteração da ação de um botão e assim por diante).

Fazer modificações em tempo de execução em barras de ferramentas

Existem várias modificações que você pode fazer em uma barra de ferramentas em tempo de execução. Uma dessas modificações é alterar o estado de um botão de barra de comando na barra de ferramentas. Cada controle de botão tem dois estados ativos: pressionado (True e não pressionado (False). Para alterar o estado de um controle de botão, use a constante apropriada para a propriedade State, conforme explicado na tabela encontrada posteriormente neste tópico.

Uma outra modificação que você pode fazer em tempo de execução é alterar a aparência ou a ação de um botão. Para alterar a aparência de um botão mas não a ação, use as propriedades CopyFace e PasteFace. Essas propriedades são úteis quando você deseja copiar a face de um determinado botão para a Área de transferência ou importá-la em um outro aplicativo para alterar algumas de suas características. Use a propriedade PasteFace para transferir a imagem do botão da Área de transferência para um botão específico.

Para alterar a ação de um botão para uma função que você tenha desenvolvido, atribua o nome do procedimento personalizado à propriedade OnAction do botão.

A tabela seguinte lista algumas das propriedades e métodos mais comuns para alteração do estado, aparência ou ação de um botão.

Propriedade ou método	Descrição
CopyFace, PasteFace	Copia ou cola a imagem na face de um botão. Use o método CopyFace para copiar a face do botão especificado para a Área de transferência. Use o método PasteFace para colar o conteúdo da Área de transferência na face do botão especificado. O método PasteFace falhará se a Área de transferência estiver vazia. Se a imagem na Área de transferência for muito grande para a face do botão, a imagem não será redimensionada. Geralmente, é mais conveniente copiar e colar a face de um botão em tempo de criação, mas você também pode fazer alterações na face de um botão em tempo de execução. Você também pode usar a propriedade FaceId para atribuir a um botão uma face de botão interna diferente a um botão.
Id	Especifica o valor que representa a funcionalidade interna do botão. Por exemplo, um botão que copia texto realçado para a Área de transferência tem um valor Id de 19.
State	Especifica a aparência ou estado do botão. Pode ser uma das seguintes constantes: msoButtonDown, msoButtonMixed ou msoButtonUp.
Style	Especifica se a face do botão exibe o seu ícone ou sua legenda. Pode ser uma das seguintes constantes: msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption.
OnAction	Especifica o procedimento a ser executado quando o usuário clicar em um botão, exibir um menu ou alterar o conteúdo de um controle caixa de combinação.
Visible	Especifica se o controle deve ser exibido ou ocultado do usuário.
Enabled	Ativa ou desativa uma barra de comando; o nome de uma barra de comando desativada não aparecerá na lista de barras de comando disponíveis.
O exemplo seguinte assume que os dois primeiros controles da barra de comando CustomButtons são botões. O procedimento HideThem oculta o primeiro botão e atribui um procedimento à propriedade OnAction do segundo botão. Quando o procedimento OnAction é executado, o primeiro controle é tornado visível e o segundo controle é tornado oculto. Se o segundo botão for pressionado enquanto o procedimento estiver sendo executado, o procedimento será suspenso. Observe que você precisa declarar tanto startBtn quanto stopBtn como variáveis globais.

Sub HideThem()

Set v = CommandBars("CustomButtons")

Set startBtn = v.Controls(1)

With startBtn

    .Visible = False

    .Caption = "Stop Processing"

End With

Set stopBtn = v.Controls(2)

stopBtn.OnAction = "onActionButtons"

End Sub

Sub onActionButtons()

stopBtn.Visible = False

With startBtn

    .Visible = True

    .Style = msoButtonCaption

End With

Do While startBtn.State <> True

'Continue processing sub

Loop

End Sub

Adicionar e modificar controles caixa de combinação

As caixas de edição, caixas de listagem suspensas e caixas de combinação são novos controles poderosos que você pode adicionar a barras de ferramentas em seu aplicativo do Visual Basic. Entretanto, a maioria dos aplicativos recipiente requer que você use código do Visual Basic para criar esses controles. Para criar um controle caixa de combinação, você usa as propriedades e métodos descritos na tabela seguinte.

Propriedade ou método	Descrição
Add	Adiciona um controle caixa de combinação a uma barra de comando especificando uma das seguintes constantes MsoControlType para o argumento Type: msoControlEdit, msoControlDropdown ou msoControlComboBox.
AddItem	Adiciona um item à parte lista drop-down de uma caixa de combinação ou caixa de listagem drop-down. Você pode especificar o número de índice do novo item na lista existente, mas se esse número for maior que o número de itens da lista, AddItem falhará.
Caption	Especifica o rótulo do controle caixa de combinação. Este é o rótulo que é exibido próximo ao controle quando você define a propriedade Style como msoComboLabel.
Style	Especifica se a legenda do controle especificado será exibida próxima ao controle. Pode ser uma das seguintes constantes: msoComboLabel (o rótulo é exibido) ou msoComboNormal (o rótulo não é exibido).
OnAction	Especifica o procedimento a ser executado quando o usuário altera o conteúdo do controle caixa de combinação.
O exemplo seguinte adiciona uma caixa de combinação com o rótulo "Quarter" a uma barra de ferramentas personalizada e atribui a macro chamada "ScrollToQuarter" ao controle.

Set newCombo = CommandBars("Custom1").Controls _

    .Add(Type:=msoControlComboBox)

With newCombo

    .AddItem "Q1"

    .AddItem "Q2"

    .AddItem "Q3"

    .AddItem "Q4"

    .Style = msoComboNormal

    .OnAction = "ScrollToQuarter"

End With

Enquanto o seu aplicativo está sendo executado, o procedimento atribuído à propriedade OnAction do controle caixa de combinação será chamado toda vez que o usuário alterar o controle. No procedimento, você pode usar a propriedade ActionControl do objeto CommandBars para descobrir qual controle foi alterado e para retornar o valor alterado. A propriedade ListIndex retornará o item digitado ou selecionado na caixa de combinação.


Adicionar e manipular barras de menu e itens de menu

Alguns aplicativos recipientes não oferecem uma maneira de você criar novas barras de menu, portanto você terá que criar barras de menu usando o Visual Basic. Após ter criado uma barra de menu no Visual Basic, você pode personalizá-la usando a interface do aplicativo recipiente ou continuando a usar o Visual Basic.

Adicionar barras de menu em tempo de execução

Quando você adiciona uma barra de menu a um aplicativo em tempo de execução, você usa o método Add da coleção CommandBars e especifica True para o argumento MenuBar. O exemplo seguinte adiciona uma barra de menu que não pode ser movida. O exemplo também ancora essa barra de menu ao longo do lado direito da janela do aplicativo. A nova barra de menu se torna ativa sempre que o usuário pressiona a tecla ALT.

Set menubar = CommandBars.Add _

    (Name:="mBar", Position:=msoBarRight, MenuBar:=True)

With menubar

    .Protection = msoBarNoMove

    .Visible = True

End With

Fazer modificações em tempo de execução em barras de menu

Você pode fazer modificações tanto na barra de menu quanto nos controles dessa barra de menu em tempo de execução. As alterações que você faz na barra de menu podem afetar sua aparência ou sua posição; as alterações que você faz nos controles dependem do tipo de controle. As propriedades e métodos listados na tabela seguinte são os mais freqüentemente usados para modificar barras de menu em tempo de execução.

Propriedade ou método	Descrição
Add	Adiciona uma barra de menu usando o método Add da coleção CommandBars e especificando True para o argumento MenuBar.
Enabled	Se essa propriedade estiver definida como True, o usuário poderá tornar visível a barra de menu especificada, usando código do Visual Basic. Se essa propriedade estiver definida como False, o usuário não poderá tornar visível a barra de menu, mas ela aparecerá na lista de barras de comando disponíveis.
Protection	Torna possível para você proteger a barra de menu contra ações específicas de usuário. Pode ser uma das seguintes constantes ou uma soma delas: msoBarNoChangeDock, msoBarNoChangeVisible, msoBarNoCustomize, msoBarNoCustomize, msoBarNoHorizontalDock, msoBarNoMove, msoBarNoProtection, msoBarNoResize e msoBarNoVerticalDock.
Position	Especifica a posição da nova barra de menu, em relação à janela do aplicativo. Pode ser uma das seguintes constantes: msoBarLeft, msoBarTop, msoBarRight, msoBarBottom, msoBarFloating ou msoBarPopup (usada para criar menus de atalho).
Visible	Especifica se o controle será exibido ou ocultado do usuário. Se o controle for ocultado do usuário, o nome da barra de menu ainda aparecerá na lista de barras de comando disponíveis.
O exemplo seguinte oculta a barra de menu ativa e a substitui por uma barra de menu temporária ancorada no lado direito da janela do aplicativo e protegida contra o usuário.

Set oldMbar = CommandBars.ActiveMenuBar

Set newMbar = CommandBars.Add _

(Name:="newMenubar", Position:=msoBarRight, _

MenuBar:=True, temporary:=True)

With newMbar

    .Visible = True

    .Protection = msoBarNoMove

End With

Mesclar barras de menu em tempo de execução

Se você tem barras de menu personalizadas em um aplicativo que você pretende que seja um suplemento, você talvez queira especificar a maneira como os controles serão representados no aplicativo recipiente. Você pode usar a propriedade OLEMenuGroup do controle CommandBarPopup para especificar como ocorrerá a mesclagem de barras de menu.

Se o aplicativo recipiente ou o servidor não implementar barras de comando, ocorrerá uma mesclagem "não Office": a barra de menu será mesclada, juntamente com todas as barras de ferramentas do servidor, e nenhuma das barras de ferramentas do aplicativo recipiente será mesclada. Você também pode usar a propriedade OLEUsage para especificar como ocorrerá a mesclagem de barra de menu.

Se ambos o aplicativo recipiente e o servidor implementar em barras de comando, ocorrerá uma mesclagem "Office em Office": os controles de barra de comando serão incorporados no aplicativo do Office, controle por controle. Ambas essas propriedades (OLEMenuGroup e OLEUsage) só são relevantes para controles pop-up em barras de menu, uma vez que os menus são considerados com base em sua categoria de grupo de menu.

Fazer modificações em tempo de execução em itens de menu

O intervalo de modificações que você pode fazer em um item de menu depende do tipo de controle. Geralmente, os botões são ativados ou ocultados. As caixas de edição, caixas de listagem drop-down e caixas de combinação são mais versáteis porque você pode adicionar ou excluir itens da lista e pode determinar a ação efetuada pelo exame do valor selecionado. Você pode alterar a ação de qualquer controle para uma função personalizada ou interna.

A tabela seguinte lista as propriedades e métodos mais comuns para alteração do estado, ação ou conteúdo de um controle.

Propriedade ou método	Objetivo
Add	Adiciona um item de menu a uma barra de comando. Pode ser uma das seguintes constantes MsoControlType para o argumento Type de um controle interno: msoControlButton, msoControlEdit, msoControlDropdown ou msoControlComboBox.
AddItem	Adiciona um item à parte lista drop-down de uma caixa de combinação ou caixa de listagem drop-down. Você pode especificar o número de índice do novo item na lista existente, mas se esse número for maior que o número de itens da lista, AddItem falhará.
Style	Especifica se a face do botão exibe o seu ícone ou sua legenda. Pode ser uma das seguintes constantes: msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption.
OnAction	Especifica o procedimento a ser executado sempre que o usuário alterar o valor do controle especificado.
Visible	Especifica se o controle será exibido ou ocultado do usuário.
O exemplo seguinte adiciona um controle pop-up temporário chamado "Custom" no final da barra de menu ativa e, em seguida, adiciona um controle de botão chamado "Import" na barra de comando pop-up personalizada.

Set myMenuBar = CommandBars.ActiveMenuBar

Set newMenu = myMenuBar.Controls.Add(Type:=msoControlPopup, Temporary:=True)

newMenu.Caption = "Custom"

Set ctrl1 = newMenu.Controls

    .Add(Type:=msoControlButton, Id:=1)

ctrl1.Caption = "Import"

ctrl1.TooltipText = "Import"

ctrl1.Style = msoButtonCaption


Adicionar e exibir menus de atalho

Um menu de atalho é uma barra de comando flutuante que o usuário exibe clicando com o botão direito. Ele pode conter os mesmos tipos de controle que uma barra de comando, e os controles se comportam da mesma maneira que em uma barra de comando. Na maioria dos aplicativos, porém, você não pode criar ou modificar menus de atalho a partir da interface de aplicativo. Portanto, você precisa criar e modificar os seus menus de atalho em tempo de execução.

Adicionar menus de atalho em tempo de execução

A única diferença entre os menus de atalho e outras barras de ferramentas é que, quando você cria o menu de atalho com o método Add, você precisa especificar msoBarPopUp como argumento Position. O exemplo seguinte cria um novo menu de atalho, adiciona dois controles (com legendas) a ele e, em seguida, usa o método ShowPopup para exibir o novo menu.

Set x = CommandBars.Add("Custom", msoBarPopup)

Set y = x.Controls.Add

With y

    .FaceId = 26

    .Caption = "Analyze the data"

End With

Set z = x.Controls.Add

With z

    .FaceId = 17

    .Caption = "Graph the data"

End With

x.ShowPopup 200, 200

Exibir menus de atalho

Use o método ShowPopup para exibir menus de atalho, conforme demonstrado no exemplo anterior.

Se o aplicativo recipiente suportar a atribuição de procedimentos de evento a ações do usuário, você poderá exibir o menu de atalho em resposta a um evento de clique com o botão direito. Entretanto, nem todos os aplicativos suportam procedimentos de evento. Verifique a documentação de seu aplicativo recipiente para ver se o aplicativo suporta procedimentos de evento.

Fazer modificações em tempo de execução em menus de atalho

Quaisquer alterações que você faça ao menu de atalho terão de ser feitas em tempo de execução, e as alterações feitas geralmente estarão limitadas a alteração da aparência ou ação dos controles do menu. Para obter maiores informações sobre como adicionar e manipular itens de menu, consulte Adicionar e gerenciar barras de menu e itens de menu.


Objetos do Microsoft Office


Retornar um objeto de uma coleção

A propriedade Item retorna um único objeto de uma coleção. O exemplo seguinte define a variável cmdbar com um objeto CommandBar que represente a primeira barra de comando da coleção.

Set cmdbar = CommandBars.Item(1)

A propriedade Item é a propriedade padrão para a maioria das coleções, portanto você pode escrever a mesma instrução de maneira mais concisa omitindo a palavra-chave Item.

Set cmdbar = CommandBars(1)

Para obter maiores informações sobre uma coleção específica, consulte o tópico de Ajuda da coleção ou da propriedade Item da coleção.


Tópico da Ajuda não disponível

O tópico da Ajuda não pode ser exibido porque a Ajuda do Visual Basic para Aplicativos não pôde ser localizada ou não foi instalada.

Para instalar a Ajuda do Visual Basic para Aplicativos

1.	Execute o Programa de Instalação do Microsoft Office 97 e clique em Adicionar/remover.

2.	Clique em Microsoft Access, Microsoft Excel, Microsoft PowerPoint ou Microsoft Word e, em seguida, clique em Alterar opção.

3.	Clique em Ajuda e, em seguida, clique em Alterar opção.

4.	Certifique-se de que a caixa de seleção Ajuda do Visual Basic ou Referência de linguagem (Microsoft Access) esteja marcada.

5.	Continue com o Programa de Instalação.


Identificadores programáticos OLE (controles ActiveX)

Você usa um identificador programático OLE (às vezes chamado de ProgID) para criar um objeto de Automação. Use um dos seguintes identificadores programáticos OLE para criar um controle ActiveX.

Use este identificador	Para criar este objeto
Forms.CheckBox.1	CheckBox
Forms.ComboBox.1	ComboBox
Forms.CommandButton.1	CommandButton
Forms.Frame.1	Frame
Forms.Image.1	Image
Forms.Label.1	Label
Forms.ListBox.1	ListBox
Forms.MultiPage.1	MultiPage
Forms.OptionButton.1	OptionButton
Forms.ScrollBar.1	ScrollBar
Forms.SpinButton.1	SpinButton
Forms.TabStrip.1	TabStrip
Forms.TextBox.1	TextBox
Forms.ToggleButton.1	ToggleButton