Classe Worksheet (Excel VBA)

A classe Worksheet representa uma planilha.

Os principais procedimentos da classe Worksheet são Sheets.Add, Sheets.Copy, Sheets.Delete, Sheets.Select, Activate, Copy, Delete, Select, Worksheets.Add, Worksheets.Copy, Worksheets.Delete e Worksheets.Select

Set

Para usar uma variável de classe Worksheet, ela primeiro precisa ser instanciada por exemplo

Dim ws as Worksheet
Set ws = ActiveSheet

Os procedimentos a seguir podem ser usados ​​para definir variáveis ​​do tipo Worksheet: Application.Charts, Application.Sheets, Application.Worksheets, Window.SelectedSheets, Workbook.Charts, Workbook.Sheets, Workbook.Worksheets, Application.ActiveSheet, Chart.Next, Chart.Previous, HPageBreak.Parent, Range.Parent, Range.Worksheet, Sheets.Item, Sheets.Item, Sheets.Add, Sheets.Add, Slicer.Parent, VPageBreak.Parent, Window.ActiveSheet, Workbook.ActiveSheet, Next, Previous, Worksheets.Item e Worksheets.Add

For Each

Aqui está um exemplo de processamento dos itens Worksheet em uma coleção.

Dim wsChart As Worksheet
For Each ws In Worksheets
	
Next ws

Temas

Alguns procedimentos nesta classe foram agrupados em temas e são descritos em páginas de tema separadas

Add with its procedures Sheets.Add e Worksheets.Add
Copy with its procedures Sheets.Copy, Copy e Worksheets.Copy
Print with its procedures Sheets.HPageBreaks, Sheets.PrintOut, Sheets.PrintPreview, Sheets.VPageBreaks, DisplayPageBreaks, HPageBreaks, PageSetup, PrintedCommentPages, PrintOut, PrintPreview, ResetAllPageBreaks, VPageBreaks, Worksheets.HPageBreaks, Worksheets.PrintOut, Worksheets.PrintPreview e Worksheets.VPageBreaks
Select with its procedures Sheets.Select, Select e Worksheets.Select
Display/Show with its procedures DisplayRightToLeft, ShowAllData e ShowDataForm
Enable with its procedures EnableCalculation, EnableFormatConditionsCalculation, EnableOutlining, EnablePivotTable e EnableSelection
Protect with its procedures Protect e Unprotect

Métodos

Estes são os principais métodos da classe Worksheet

Sheets.Delete - Exclui o objeto.

Charts.Delete

Activate -

ActiveSheet.Activate

Delete - Exclui o objeto.

ActiveSheet.Delete

Worksheets.Delete - Exclui o objeto.

Dim wrks As Worksheets: Set wrks = 
wrks.Delete

Estes são os principais métodos da classe

Sheets.FillAcrossSheets - Copia um intervalo para a mesma área em todas as outras planilhas de uma coleção.

Sheets.Move - Move a planilha para outro lugar na pasta de trabalho.

ChartObjects - Retorna um objeto que representa um único gráfico incorporado um objeto ChartObject ou uma coleção de todos os gráficos incorporados (um objeto ChartObjects ) na planilha.

CheckSpelling - Verifica a ortografia de um objeto.

CircleInvalid - Circunda entradas inválidas na planilha.

ClearArrows - Limpa as setas de rastreamento da planilha. Elas são adicionadas com o uso do recurso de auditoria.

ClearCircles - Retira os círculos das entradas inválidas na planilha.

Evaluate - Converte um nome do Microsoft Excel em um objeto ou em um valor.

ExportAsFixedFormat - Exporta para um arquivo do formato especificado.

Move - Move a planilha para outro lugar na pasta de trabalho.

OLEObjects - Retorna um objeto que representa um único objeto OLE um OLEObject ou uma coleção de todos os objetos OLE (uma coleção OLEObjects) no gráfico ou planilha. Somente leitura.

Paste - Cola o conteúdo da Área de Transferência na planilha.

PasteSpecial - Cola o conteúdo da Área de Transferência na planilha, usando um formato especificado. Use este método para colar dados de outros aplicativos ou para colar dados em um formato específico.

PivotTables - Retorna um objeto que representa um único relatório de tabela dinâmica um objeto PivotTable ou uma coleção de todos os relatórios de tabela dinâmica (um objeto PivotTable ) em uma planilha. Somente leitura.

PivotTableWizard - Cria um novo relatório de tabela dinâmica. Este método não exibe o assistente de tabela dinâmica. Este método não está disponível para fontes de dados OLE DB. Use o método Add para adicionar um cache de tabela dinâmica e, em seguida, crie um relatório de tabela dinâmica com base no cache.

SaveAs - Salva alterações feitas no gráfico ou na planilha em um arquivo diferente.

Scenarios - Retorna um objeto que representa um único cenário um objeto Scenario ou uma coleção de cenários (um objeto Scenarios ) na planilha.

SetBackgroundPicture - Define um gráfico de plano de fundo para uma planilha.

XmlDataQuery - Retorna um objeto Range que representa as células mapeadas para um determinado XPath. Retorna Nothing se o XPath especificado não foi mapeado para a pasta de trabalho, ou se o intervalo mapeado estiver vazio.

XmlMapQuery - Retorna um objeto Range que representa as células mapeadas para um determinado XPath. Retorna Nothing se o XPath especificado não tiver sido mapeado para a pasta de trabalho.

Worksheets.FillAcrossSheets - Copia um intervalo para a mesma área em todas as outras planilhas de uma coleção.

Worksheets.Move - Move a planilha para outro lugar na pasta de trabalho.

Propriedades

Sheets.Count Retorna um valor Long que representa o número de objetos na coleção.

Dim lngCount As Long
lngCount = Charts.Count

Sheets.Item Retorna um único objeto de uma coleção.

Dim chrItem As Chart
Set chrItem = Charts(Index:=1)

Sheets.Parent Retorna o objeto pai do objeto especificado. Somente leitura.

Dim wbParent As Workbook
Set wbParent = Charts.Parent

Sheets.Visible Retorna ou define um valor que determina se o objeto está visível.

Charts.Visible = True

AutoFilter Retorna um objeto AutoFilter se o filtro estiver ativado. Somente leitura.

Dim afrAutoFilter As AutoFilter
Set afrAutoFilter = ActiveSheet.AutoFilter

AutoFilterMode True se as setas suspensas do filtro automático estiverem atualmente exibidas na planilha. Essa propriedade é independente da propriedade FilterMode . Boolean de leitura/gravação.

ActiveSheet.AutoFilterMode = True

Cells Retorna um objeto Range que representa todas as células da planilha não apenas as células em uso no momento.

Dim rngCells As Range
Set rngCells = ActiveSheet.Cells

CircularReference Retorna um objeto Range que representa o intervalo que contém a primeira referência circular na planilha ou retorna Nothing se não houver nenhuma referência circular na planilha. A referência circular precisa ser removida antes do cálculo prosseguir.

Dim rngCircularReference As Range
Set rngCircularReference = ActiveSheet.CircularReference

CodeName Retorna o nome de código do objeto. String somente leitura.

Dim strCodeName As String
strCodeName = ActiveSheet.CodeName

Columns Retorna um objeto Range que representa todas as colunas na planilha especificada.

Dim rngColumns As Range
Set rngColumns = ActiveSheet.Columns

Comments Retorna uma coleção Comments que representa todos os comentários da planilha especificada. Somente leitura.

Dim cmmsComments As Comments
Set cmmsComments = ActiveSheet.Comments

CommentsThreaded Retorna uma coleção CommentsThreaded que representa todos os comentários de nível superior/raiz sem respostas da planilha especificada. Inclui comentários herdados e modernos. Somente leitura.

Dim ctdCommentsThreaded As CommentsThreaded
Set ctdCommentsThreaded = ActiveSheet.CommentsThreaded

ConsolidationFunction Retorna o código de função usado para a consolidação atual. Pode ser uma das constantes de XlConsolidationFunction. Long somente leitura.

Dim xcfConsolidationFunction As XlConsolidationFunction
xcfConsolidationFunction = ActiveSheet.ConsolidationFunction

ConsolidationOptions Retorna uma matriz de três elementos de opções de consolidação, como mostrado na tabela seguinte. Se o elemento for True, essa opção será definida. Somente leitura .

Dim varConsolidationOptions As Variant
varConsolidationOptions = ActiveSheet.ConsolidationOptions

ConsolidationSources Retorna uma matriz de valores de sequência de caracteres informando os nomes das planilhas de origem para a consolidação da planilha atual. Retorna Empty se não houver consolidação na planilha. Somente leitura .

Dim varConsolidationSources As Variant
varConsolidationSources = ActiveSheet.ConsolidationSources

CustomProperties Retorna um objeto CustomProperties que representa as informações de identificador associadas a uma planilha.

Dim cpsCustomProperties As CustomProperties
Set cpsCustomProperties = ActiveSheet.CustomProperties

EnableAutoFilter True se as setas do AutoFiltro estiverem ativadas quando a proteção apenas da interface do usuário estiver ativada. Boolean de leitura/gravação.

ActiveSheet.EnableAutoFilter = True

FilterMode True se a planilha está no modo de filtro. Boolean somente leitura.

Dim booFilterMode As Boolean
booFilterMode = ActiveSheet.FilterMode

Hyperlinks Retorna uma coleção hyperlinks que representa os hiperlinks da planilha.

Dim hypsHyperlinks As Hyperlinks
Set hypsHyperlinks = ActiveSheet.Hyperlinks

Index Retorna um valor Long que representa o número de índice do objeto dentro da coleção de objetos semelhantes.

Dim lngIndex As Long
lngIndex = ActiveSheet.Index

ListObjects Retorna uma coleção de objetos ListObject na planilha. Coleção ListObjects somente leitura.

Dim losListObjects As ListObjects
Set losListObjects = ActiveSheet.ListObjects

MailEnvelope Representa um cabeçalho de email para um documento.

Dim meeMailEnvelope As Office.MsoEnvelope
Set meeMailEnvelope = ActiveSheet.MailEnvelope

Name Retorna ou define um valor String que representa o nome do objeto.

ActiveSheet.Name =

NamedSheetViews

Dim As Variant
ActiveSheet.NamedSheetViews

Names Retorna uma coleção de nomes que representa todos os nomes específicos da planilha nomes definidos com o "WorksheetName!" prefixo. Objeto Names somente leitura.

Dim nmsNames As Names
Set nmsNames = ActiveSheet.Names

Next Retorna um objeto Worksheet que representa a próxima planilha.

Dim wsNext As Worksheet
Set wsNext = ActiveSheet.Next

Outline Retorna um objeto outline que representa a estrutura de tópicos da planilha especificada. Somente leitura.

Dim otlOutline As Outline
Set otlOutline = ActiveSheet.Outline

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

Dim wbParent As Workbook
Set wbParent = ActiveSheet.Parent

Previous Retorna um objeto Worksheet que representa a planilha anterior.

Dim wsPrevious As Worksheet
Set wsPrevious = ActiveSheet.Previous

ProtectContents True se o conteúdo da planilha estiver protegido. Isso protege as células individuais. Para ativar a proteção de conteúdo, use o método Protect com o argumento Content definido como true. Boolean somente leitura.

Dim booProtectContents As Boolean
booProtectContents = ActiveSheet.ProtectContents

ProtectDrawingObjects True se as formas estiverem protegidas. Para ativar a proteção de forma, use o método Protect com o argumento DrawingObjects definido como true. Boolean somente leitura.

Dim booProtectDrawingObjects As Boolean
booProtectDrawingObjects = ActiveSheet.ProtectDrawingObjects

Protection Retorna um objeto Protection que representa as opções de proteção da planilha.

Dim prtProtection As Protection
Set prtProtection = ActiveSheet.Protection

ProtectionMode True se a proteção somente da interface do usuário estiver ativada. Para ativar a proteção da interface do usuário, use o método Protect com o argumento UserInterfaceOnly definido como true. Boolean somente leitura.

Dim booProtectionMode As Boolean
booProtectionMode = ActiveSheet.ProtectionMode

ProtectScenarios True se os cenários de planilha estiverem protegidos. Boolean somente leitura.

Dim booProtectScenarios As Boolean
booProtectScenarios = ActiveSheet.ProtectScenarios

QueryTables Retorna a coleção QueryTables que representa todas as tabelas de consulta na planilha especificada. Somente leitura.

Dim qtsQueryTables As QueryTables
Set qtsQueryTables = ActiveSheet.QueryTables

Range Retorna um objeto Range que representa uma célula ou um intervalo de células.

Dim strCell1 As String: strCell1 = 
Dim rngRange As Range
Set rngRange = ActiveSheet.Range(Cell1:=strCell1)

Rows Retorna um objeto Range que representa todas as linhas na planilha especificada.

Dim rngRows As Range
Set rngRows = ActiveSheet.Rows

ScrollArea Retorna ou define o intervalo com permissão para rolagem, como uma referência de intervalo no estilo A1. As células fora da área de rolagem não podem ser selecionadas. String de leitura/gravação.

ActiveSheet.ScrollArea =

Shapes Retorna uma coleção Shapes que representa todas as formas na planilha. Somente leitura.

Dim shpsShapes As Shapes
Set shpsShapes = ActiveSheet.Shapes

Sort Retorna um objeto Sort . Somente leitura.

Dim srtSort As Sort
Set srtSort = ActiveSheet.Sort

StandardHeight Retorna a altura padrão padrão de todas as linhas da planilha, em pontos. Double somente leitura.

Dim dblStandardHeight As Double
dblStandardHeight = ActiveSheet.StandardHeight

StandardWidth Retorna ou define a largura padrão de todas as colunas da planilha. Double de leitura/gravação.

ActiveSheet.StandardWidth =

Tab Retorna um objeto Tab para uma planilha.

Dim tabTab As Tab
Set tabTab = ActiveSheet.Tab

TransitionExpEval True se o Microsoft Excel usar as regras de avaliação de expressões do Lotus 1-2-3 para a planilha. Boolean de leitura/gravação.

ActiveSheet.TransitionExpEval = True

TransitionFormEntry True se o Microsoft Excel usar as regras de entrada de fórmula do Lotus 1-2-3 para a planilha. Boolean de leitura/gravação.

ActiveSheet.TransitionFormEntry = True

Type Retorna um valor XlSheetType que representa o tipo de planilha.

Dim xstType As XlSheetType
xstType = ActiveSheet.Type

UsedRange Retorna um objeto Range que representa o intervalo usado na planilha especificada. Somente leitura.

Dim rngUsedRange As Range
Set rngUsedRange = ActiveSheet.UsedRange

Visible Retorna ou define um valor XlSheetVisibility que determina se o objeto está visível.

ActiveSheet.Visible = xlSheetHidden

Worksheets.Count Retorna um valor Long que representa o número de objetos na coleção.

Dim wrks As Worksheets: Set wrks = 
Dim lngCount As Long
lngCount = wrks.Count

Worksheets.Item Retorna um único objeto de uma coleção.

Dim wrks As Worksheets: Set wrks = 
Dim wsItem As Worksheet
Set wsItem = wrks(Index:=1)

Worksheets.Parent Retorna o objeto pai do objeto especificado. Somente leitura.

Dim wrks As Worksheets: Set wrks = 
Dim objParent As Object
Set objParent = wrks.Parent

Worksheets.Visible Retorna ou define um valor que determina se o objeto será visível.

Dim wrks As Worksheets: Set wrks = 
wrks.Visible = True