Class ExcelQueryTable

A Query Table connected to an ExcelTable object.

Inheritance

object

DocumentPart<ExcelQueryTable>

ExcelQueryTable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OfficeOpenXml.Data.QueryTable

Assembly: EPPlus.dll

Syntax

public class ExcelQueryTable : DocumentPart<ExcelQueryTable>

Properties

AdjustColumnWidth

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

Declaration

public bool AdjustColumnWidth { get; set; }

Property Value

Type	Description
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.

Declaration

public bool? ApplyAlignmentFormats { get; set; }

Property Value

Type	Description
bool?

ApplyBorderFormats

If true, apply legacy table autoformat border properties.

Declaration

public bool? ApplyBorderFormats { get; set; }

Property Value

Type	Description
bool?

ApplyFontFormats

If true, apply legacy table autoformat font properties.

Declaration

public bool? ApplyFontFormats { get; set; }

Property Value

Type	Description
bool?

ApplyNumberFormats

If true, apply legacy table autoformat number format properties.

Declaration

public bool? ApplyNumberFormats { get; set; }

Property Value

Type	Description
bool?

ApplyPatternFormats

If true, apply legacy table autoformat pattern properties.

Declaration

public bool? ApplyPatternFormats { get; set; }

Property Value

Type	Description
bool?

ApplyWidthHeightFormats

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

Declaration

public bool? ApplyWidthHeightFormats { get; set; }

Property Value

Type	Description
bool?

AutoFormatId

Identifies which legacy table autoformat to apply.

Declaration

public int? AutoFormatId { get; set; }

Property Value

Type	Description
int?

BackgroundRefresh

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

Declaration

public bool? BackgroundRefresh { get; set; }

Property Value

Type	Description
bool?

Connection

The connection used for the query table.

Declaration

public ExcelConnection Connection { get; }

Property Value

Type	Description
ExcelConnection

DeletedFields

A collection of deleted fields from the query table.

Declaration

public EPPlusReadOnlyList<string> DeletedFields { get; }

Property Value

Type	Description
EPPlusReadOnlyList<string>

DestinationRange

The destination range for the query table.

Declaration

public ExcelAddressBase DestinationRange { get; }

Property Value

Type	Description
ExcelAddressBase

DisableEdit

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

Declaration

public bool DisableEdit { get; set; }

Property Value

Type	Description
bool

DisableRefresh

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

Declaration

public bool DisableRefresh { get; set; }

Property Value

Type	Description
bool

Fields

The fields mapping to the column in the table.

Declaration

public EPPlusReadOnlyList<ExcelQueryTableField> Fields { get; }

Property Value

Type	Description
EPPlusReadOnlyList<ExcelQueryTableField>

FillFormulas

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

Declaration

public bool FillFormulas { get; set; }

Property Value

Type	Description
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.

Declaration

public bool? FirstBackgroundRefresh { get; set; }

Property Value

Type	Description
bool?

GrowShrinkType

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

Declaration

public QueryTableGrowShrinkType GrowShrinkType { get; set; }

Property Value

Type	Description
QueryTableGrowShrinkType

Headers

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

Declaration

public bool Headers { get; set; }

Property Value

Type	Description
bool

Intermediate

Specifies whether this query table is in an intermediate state.

Declaration

public bool Intermediate { get; set; }

Property Value

Type	Description
bool

Name

Specifies the name of the query table. Reqired.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

PreserveFormatting

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

Declaration

public bool PreserveFormatting { get; set; }

Property Value

Type	Description
bool

RefreshOnLoad

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

Declaration

public bool RefreshOnLoad { get; set; }

Property Value

Type	Description
bool

RemoveDataOnSave

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

Declaration

public bool? RemoveDataOnSave { get; set; }

Property Value

Type	Description
bool?

RowNumbers

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

Declaration

public bool RowNumbers { get; set; }

Property Value

Type	Description
bool