Skip to content

Class ExcelQueryTable

Namespace: OfficeOpenXml.Data.QueryTable
Assembly: EPPlus.dll

A Query Table connected to an ExcelTable object.

public class ExcelQueryTable : DocumentPart<ExcelQueryTable>

Inheritance

object ← DocumentPart<ExcelQueryTable> ← ExcelQueryTable

Inherited Members

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties

AdjustColumnWidth

Specifies whether to automatically adjust column widths on refresh to fit the data retrieved. true if column widths should be adjusted.

public bool AdjustColumnWidth { get; set; }

Property Value

bool

ApplyAlignmentFormats

If true, apply legacy table autoformat alignment properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

public bool? ApplyAlignmentFormats { get; set; }

Property Value

bool?

ApplyBorderFormats

If true, apply legacy table autoformat border properties.

public bool? ApplyBorderFormats { get; set; }

Property Value

bool?

ApplyFontFormats

If true, apply legacy table autoformat font properties.

public bool? ApplyFontFormats { get; set; }

Property Value

bool?

ApplyNumberFormats

If true, apply legacy table autoformat number format properties.

public bool? ApplyNumberFormats { get; set; }

Property Value

bool?

ApplyPatternFormats

If true, apply legacy table autoformat pattern properties.

public bool? ApplyPatternFormats { get; set; }

Property Value

bool?

ApplyWidthHeightFormats

If true, apply legacy table autoformat width/height properties.

public bool? ApplyWidthHeightFormats { get; set; }

Property Value

bool?

AutoFormatId

Identifies which legacy table autoformat to apply.

public int? AutoFormatId { get; set; }

Property Value

int?

BackgroundRefresh

Specifies whether the query table shall try to refresh data in the background.

public bool? BackgroundRefresh { get; set; }

Property Value

bool?

Connection

The connection used for the query table.

public ExcelConnection Connection { get; }

Property Value

ExcelConnection

DeletedFields

A collection of deleted fields from the query table.

public EPPlusReadOnlyList<string> DeletedFields { get; }

Property Value

EPPlusReadOnlyList<string>

DestinationRange

The destination range for the query table.

public ExcelAddressBase DestinationRange { get; }

Property Value

ExcelAddressBase

DisableEdit

Specifies whether the connection used with this query table shall be editable. If true, then the connection is not editable.

public bool DisableEdit { get; set; }

Property Value

bool

DisableRefresh

Specifies whether the query table shall be refreshable. If true, then the query table is not refreshable.

public bool DisableRefresh { get; set; }

Property Value

bool

Fields

The fields mapping to the column in the table.

public EPPlusReadOnlyList<ExcelQueryTableField> Fields { get; }

Property Value

EPPlusReadOnlyList<ExcelQueryTableField>

FillFormulas

Specifies whether formulas in columns adjacent to the query table should be filled down when refreshed.

public bool FillFormulas { get; set; }

Property Value

bool

FirstBackgroundRefresh

Specifies whether the first background data refresh has completed. If true, the very first background refresh had not completed when the file was saved.

public bool? FirstBackgroundRefresh { get; set; }

Property Value

bool?

GrowShrinkType

Specifies how to handle variable numbers of rows between refresh operations.

public QueryTableGrowShrinkType GrowShrinkType { get; set; }

Property Value

QueryTableGrowShrinkType

Headers

Specifies whether the query table has a first row with column titles.

public bool Headers { get; set; }

Property Value

bool

Intermediate

Specifies whether this query table is in an intermediate state.

public bool Intermediate { get; set; }

Property Value

bool

Name

Specifies the name of the query table. Reqired.

public string Name { get; set; }

Property Value

string

PreserveFormatting

Specifies whether formatting in the query table should be preserved and copied to new rows.

public bool PreserveFormatting { get; set; }

Property Value

bool

RefreshOnLoad

Specifies whether the query table shall refresh automatically when the document is loaded.

public bool RefreshOnLoad { get; set; }

Property Value

bool

RemoveDataOnSave

Specifies whether all data shall be removed before saving the document.

public bool? RemoveDataOnSave { get; set; }

Property Value

bool?

RowNumbers

Specifies whether the query table shall include a first column of row numbers.

public bool RowNumbers { get; set; }

Property Value

bool