Blazor Using Worksheets

    O Infragistics Blazor Excel Engine Worksheet é onde seus dados são mantidos. Você pode inserir dados trabalhando com as linhas e células da planilha e definindo seus valores correspondentes. O permite Worksheet filtrar, classificar e personalizar os formatos das células, conforme mostrado abaixo.

    Blazor Using Worksheets Example

    Configuring the Gridlines

    As linhas de grade são usadas para separar visualmente as células na planilha. Você pode mostrar ou ocultar as linhas de grade e também alterar suas cores.

    Você pode mostrar ou ocultar as linhas de grade usando a ShowGridlines propriedade da DisplayOptions planilha. O código a seguir demonstra como você pode ocultar as linhas de grade em sua planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.DisplayOptions.ShowGridlines = false;

    Você pode configurar a cor das linhas de grade usando a GridlineColor propriedade da DisplayOptions planilha. O código a seguir demonstra como você pode alterar as linhas de grade em sua planilha para serem vermelhas:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.DisplayOptions.GridlineColor = Core.Graphics.Colors.Red;

    Configuring the Headers

    Os cabeçalhos de coluna e linha são usados para identificar visualmente colunas e linhas. Eles também são usados para destacar visualmente a célula ou região de célula selecionada no momento.

    Você pode mostrar ou ocultar os cabeçalhos de coluna e linha usando a ShowRowAndColumnHeaders propriedade da DisplayOptions planilha. O código a seguir demonstra como você pode ocultar os cabeçalhos de linha e coluna:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.DisplayOptions.ShowRowAndColumnHeaders = false;

    Configuring Editing of the Worksheet

    Por padrão, os Worksheet objetos que você salvar serão editáveis. Você pode desabilitar a edição de uma planilha protegendo-a usando o Worksheet método do Protect objeto. Esse método tem muitos argumentos anuláveis bool que determinam quais partes são protegidas, e uma dessas opções é permitir a edição de objetos, que, se configurados como falsos, impedirão a edição da planilha.

    O código a seguir demonstra como desabilitar a edição na sua planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.Protect();

    Você também pode usar o Worksheet método do Protect objeto para proteger uma planilha contra alterações estruturais.

    Quando a proteção é definida, você pode definir a CellFormat propriedade do Locked objeto em células, linhas, regiões de célula mescladas ou colunas individuais para substituir a proteção do objeto de planilha nesses objetos. Por exemplo, se você precisar que todas as células de uma planilha sejam somente leitura, exceto as células de uma coluna, poderá proteger a planilha e definir a CellFormat propriedade do Locked objeto como false em um objeto específico WorksheetColumn. Isso permitirá que os usuários editem células dentro da coluna enquanto desabilitam a edição das outras células na planilha.

    O código a seguir demonstra como você pode fazer isso:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.Protect();
worksheet.Columns[0].CellFormat.Locked = ExcelDefaultableBoolean.False;

    Filtering Worksheet Regions

    A filtragem é feita definindo uma condição de filtro em uma planilha WorksheetFilterSettings que pode ser recuperada da Worksheet propriedade do FilterSettings objeto. As condições de filtro só são reaplicadas quando são adicionadas, removidas, modificadas ou quando o ReapplyFilters método é chamado na planilha. Eles não são constantemente avaliados à medida que os dados dentro da região mudam.

    Você pode especificar a região para aplicar o filtro usando o SetRegion​ ​WorksheetFilterSettings método no objeto.

    Abaixo está uma lista de métodos e suas descrições que você pode usar para adicionar um filtro a uma planilha:

    Método Descrição
    ApplyAverageFilter Representa um filtro que pode filtrar dados com base no fato de os dados estarem abaixo ou acima da média de todo o intervalo de dados.
    ApplyDatePeriodFilter Representa um filtro que pode filtrar datas em um mês ou trimestre de qualquer ano.
    ApplyFillFilter Representa um filtro que filtrará células com base em seus preenchimentos de fundo. Este filtro especifica um único CellFill. Células com este preenchimento ficarão visíveis no intervalo de dados. Todas as outras células ficarão ocultas.
    ApplyFixedValuesFilter Representa um filtro que pode filtrar células com base em valores específicos e fixos, que podem ser exibidos.
    ApplyFontColorFilter Representa um filtro que filtrará células com base em suas cores de fonte. Este filtro especifica uma única cor. Células com esta fonte de cor serão visíveis no intervalo de dados. Todas as outras células serão ocultadas.
    ApplyIconFilter Representa um filtro que pode filtrar células com base em seu ícone de formatação condicional.
    ApplyRelativeDateRangeFilter Representa um filtro que pode filtrar células de data com base em datas relativas a quando o filtro foi aplicado.
    ApplyTopOrBottomFilter Representa um filtro que pode filtrar células na parte superior ou inferior dos valores classificados.
    ApplyYearToDateFilter Representa um filtro que pode filtrar em células de data se as datas ocorrerem entre o início do ano atual e o momento em que o filtro é avaliado.
    ApplyCustomFilter Representa um filtro que pode filtrar dados com base em uma ou duas condições personalizadas. Essas duas condições de filtro podem ser combinadas com uma operação lógica "e" ou uma operação lógica "ou".

    Você pode usar o seguinte trecho de código como exemplo para adicionar um filtro a uma região da planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.FilterSettings.SetRegion("Sheet1!A1:A10");
worksheet.FilterSettings.ApplyAverageFilter(0, Documents.Excel.Filtering.AverageFilterType.AboveAverage);

    Freezing and Splitting Panes

    Você pode congelar linhas na parte superior da sua planilha ou colunas à esquerda usando os recursos de painéis de congelamento. Linhas e colunas congeladas permanecem visíveis o tempo todo enquanto o usuário rola. As linhas e colunas congeladas são separadas do restante da planilha por uma única linha sólida, que não pode ser removida.

    Para habilitar o congelamento do painel, você precisa definir a PanesAreFrozen​ ​Worksheet propriedade do objeto DisplayOptions como true. Em seguida, você pode especificar as linhas ou colunas a serem congeladas usando as FrozenRows propriedades e FrozenColumns das opções FrozenPaneSettings de exibição, respectivamente.

    Você também pode especificar a primeira linha no painel inferior ou a primeira coluna no painel direito usando as propriedades FirstRowInBottomPane e FirstColumnInRightPane, respectivamente.

    O trecho de código a seguir demonstra como usar os recursos de congelamento de painéis em uma planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.DisplayOptions.PanesAreFrozen = true;

worksheet.DisplayOptions.FrozenPaneSettings.FrozenRows = 3;
worksheet.DisplayOptions.FrozenPaneSettings.FrozenColumns = 3;

worksheet.DisplayOptions.FrozenPaneSettings.FirstColumnInRightPane = 2;
worksheet.DisplayOptions.FrozenPaneSettings.FirstRowInBottomPane = 6;

    Setting the Worksheet Zoom Level

    Você pode alterar o nível de zoom de cada planilha de forma independente usando a MagnificationInNormalView​ ​Worksheet propriedade no objeto DisplayOptions. Essa propriedade assume um valor entre 10 e 400 e representa a porcentagem de zoom que você deseja aplicar.

    O código a seguir demonstra como você pode fazer isso:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.DisplayOptions.MagnificationInNormalView = 300;

    Worksheet Level Sorting

    A classificação é feita definindo uma condição de classificação em um objeto de nível de planilha em colunas ou linhas. Você pode classificar colunas ou linhas em ordem crescente ou decrescente.

    Isso é feito especificando uma região e um tipo de classificação para os Worksheet objetos que podem ser recuperados WorksheetSortSettings usando a SortSettings propriedade da planilha.

    As condições de classificação em uma planilha só são reaplicadas quando as condições de classificação são adicionadas, removidas, modificadas ou quando o ReapplySortConditions método é chamado na planilha. As colunas ou linhas serão classificadas dentro da região. "Linhas" é o tipo de classificação padrão.

    O trecho de código a seguir demonstra como aplicar uma classificação a uma região de células em uma planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.SortSettings.SortConditions.Add(new RelativeIndex(0), new Infragistics.Documents.Excel.Sorting.OrderedSortCondition(Documents.Excel.Sorting.SortDirection.Ascending));

    Worksheet Protection

    Você pode proteger uma planilha chamando o Protect método no Worksheet objeto. Esse método expõe muitos parâmetros anuláveis bool que permitem restringir ou permitir as seguintes operações do usuário:

    • Edição de células.
    • Edição de objetos como formas, comentários, gráficos ou outros controles.
    • Edição de cenários.
    • Filtragem de dados.
    • Formatação de células.
    • Inserir, excluir e formatar colunas.
    • Inserir, excluir e formatar linhas.
    • Inserção de hiperlinks.
    • Classificação de dados.
    • Uso de tabelas dinâmicas.

    Você pode remover a proteção da planilha chamando o Unprotect​ ​Worksheet método no objeto.

    O trecho de código a seguir mostra como habilitar a proteção de todas as operações de usuário listadas acima:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

worksheet.Protect();

    Worksheet Conditional Formatting

    Você pode configurar a formatação condicional de um Worksheet objeto usando os muitos métodos "Add" expostos na ConditionalFormats coleção dessa planilha. O primeiro parâmetro desses métodos "Adicionar" é a string região da planilha à qual você gostaria de aplicar o formato condicional.

    Muitos dos formatos condicionais que você pode adicionar à sua planilha têm uma CellFormat propriedade que determina a aparência dos WorksheetCell elementos quando a condição nesse formato condicional for verdadeira. Por exemplo, você pode usar as propriedades anexadas a essa CellFormat propriedade, como Fill e Font para determinar as configurações de plano de fundo e fonte de suas células em um formato condicional específico, respectivamente.

    Há alguns formatos condicionais que não têm uma CellFormat propriedade, pois sua visualização na célula da planilha se comporta de maneira diferente. Esses formatos condicionais são os DataBarConditionalFormat e. ColorScaleConditionalFormat​ ​IconSetConditionalFormat​

    Ao carregar um pré-existente Workbook do Excel, os formatos serão preservados quando ele Workbook for carregado. O mesmo vale para quando você salva a Workbook saída em um arquivo do Excel.

    O exemplo de código a seguir demonstra o uso de formatos condicionais em uma planilha:

    var workbook = new Workbook();
var worksheet = workbook.Sheets.Add("Sheet1", SheetType.Worksheet) as Worksheet;

var format = worksheet.ConditionalFormats.AddAverageCondition("A1:A10", Documents.Excel.ConditionalFormatting.FormatConditionAboveBelow.AboveAverage);
format.CellFormat.Font.ColorInfo = new WorkbookColorInfo(Core.Graphics.Colors.Red);

    API References

    • CellFormat
    • ColorScaleConditionalFormat
    • ConditionalFormats
    • DataBarConditionalFormat
    • DisplayOptions
    • FilterSettings
    • ShowGridlines
    • ShowRowAndColumnHeaders
    • SortSettings
    • Workbook
    • WorksheetCell
    • WorksheetColumn
    • WorksheetFilterSettings
    • WorksheetSortSettings
    • Worksheet