Share via

Table "Excel Buffer"

ID 370
Namespace: System.IO

Properties

Name Value
Caption Excel Buffer
ReplicateData False
DataClassification CustomerContent

Fields

Name Type Description
"Row No." Integer
xlRowID Text[10]
"Column No." Integer
xlColID Text[10]
"Cell Value as Text" Text[250]
Comment Text[250]
Formula Text[250]
Bold Boolean
Italic Boolean
Underline Boolean
NumberFormat Text[30]
Formula2 Text[250]
Formula3 Text[250]
Formula4 Text[250]
"Cell Type" Option
"Double Underline" Boolean
"Cell Value as Blob" Blob
SystemId Guid
SystemCreatedAt DateTime
SystemCreatedBy Guid
SystemModifiedAt DateTime
SystemModifiedBy Guid
SystemRowVersion BigInteger

Methods

SetReadDateTimeInUtcDate

procedure SetReadDateTimeInUtcDate(NewValue: Boolean)

Parameters

Name Type Description
NewValue Boolean

EnterCellByCellName

procedure EnterCellByCellName(CellName: Text, CellValueAsText: Text[250])

Parameters

Name Type Description
CellName Text
CellValueAsText Text[250]

CreateNewBook

procedure CreateNewBook(SheetName: Text[250])

Parameters

Name Type Description
SheetName Text[250]

GetValueByCellName

procedure GetValueByCellName(CellName: Text): Text

Parameters

Name Type Description
CellName Text

Returns

Type Description
Text

OpenBookStream

procedure OpenBookStream(FileStream: InStream, SheetName: Text): Text

Parameters

Name Type Description
FileStream InStream
SheetName Text

Returns

Type Description
Text

UpdateBookStream

procedure UpdateBookStream(var ExcelStream: InStream, SheetName: Text, PreserveDataOnUpdate: Boolean)

Parameters

Name Type Description
ExcelStream InStream
SheetName Text
PreserveDataOnUpdate Boolean

CloseBook

procedure CloseBook()

SelectOrAddSheet

procedure SelectOrAddSheet(NewSheetName: Text)

Parameters

Name Type Description
NewSheetName Text

SetActiveReaderSheet

procedure SetActiveReaderSheet(NewSheetName: Text)

Parameters

Name Type Description
NewSheetName Text

WriteSheet

procedure WriteSheet(ReportHeader: Text, CompanyName2: Text, UserID2: Text)

Parameters

Name Type Description
ReportHeader Text
CompanyName2 Text
UserID2 Text

WriteAllToCurrentSheet

procedure WriteAllToCurrentSheet(var ExcelBuffer: Record "Excel Buffer")

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"

WriteCellValue

procedure WriteCellValue(ExcelBuffer: Record "Excel Buffer")

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"

WriteCellFormula

procedure WriteCellFormula(ExcelBuffer: Record "Excel Buffer")

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"

SetColumnWidth

procedure SetColumnWidth(ColName: Text[10], NewColWidth: Decimal)

Parameters

Name Type Description
ColName Text[10]
NewColWidth Decimal

ReadSheet

procedure ReadSheet()

ReadSheetContinous

procedure ReadSheetContinous(SheetName: Text, CloseBookOnCompletion: Boolean)

Parameters

Name Type Description
SheetName Text
CloseBookOnCompletion Boolean

ReadSheetContinous

procedure ReadSheetContinous(SheetName: Text, CloseBookOnCompletion: Boolean, ColumnList: List of [Integer], RowList: List of [Integer], MaxRowNo: Integer)

Parameters

Name Type Description
SheetName Text
CloseBookOnCompletion Boolean
ColumnList List of [Integer]
RowList List of [Integer]
MaxRowNo Integer

SelectSheetsNameStream

procedure SelectSheetsNameStream(FileStream: InStream): Text[250]

Parameters

Name Type Description
FileStream InStream

Returns

Type Description
Text[250]

GetExcelReference

procedure GetExcelReference(Which: Integer): Text[250]

Parameters

Name Type Description
Which Integer

Returns

Type Description
Text[250]

ExportBudgetFilterToFormula

procedure ExportBudgetFilterToFormula(var ExcelBuf: Record "Excel Buffer"): Boolean

Parameters

Name Type Description
ExcelBuf Table System.IO."Excel Buffer"

Returns

Type Description
Boolean

AddToFormula

procedure AddToFormula(Text: Text[30]): Boolean

Parameters

Name Type Description
Text Text[30]

Returns

Type Description
Boolean

GetFormula

procedure GetFormula(): Text[1000]

Returns

Type Description
Text[1000]

SetFormula

procedure SetFormula(LongFormula: Text[1000])

Parameters

Name Type Description
LongFormula Text[1000]

ClearFormula

procedure ClearFormula()

NewRow

procedure NewRow()

AddColumn

procedure AddColumn(Value: Variant, IsFormula: Boolean, CommentText: Text, IsBold: Boolean, IsItalics: Boolean, IsUnderline: Boolean, NumFormat: Text[30], CellType: Option)

Parameters

Name Type Description
Value Variant
IsFormula Boolean
CommentText Text
IsBold Boolean
IsItalics Boolean
IsUnderline Boolean
NumFormat Text[30]
CellType Option

AddInfoColumn

procedure AddInfoColumn(Value: Variant, IsFormula: Boolean, IsBold: Boolean, IsItalics: Boolean, IsUnderline: Boolean, NumFormat: Text[30], CellType: Option)

Parameters

Name Type Description
Value Variant
IsFormula Boolean
IsBold Boolean
IsItalics Boolean
IsUnderline Boolean
NumFormat Text[30]
CellType Option

EnterCell

procedure EnterCell(var ExcelBuffer: Record "Excel Buffer", RowNo: Integer, ColumnNo: Integer, Value: Variant, IsBold: Boolean, IsItalics: Boolean, IsUnderline: Boolean)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
RowNo Integer
ColumnNo Integer
Value Variant
IsBold Boolean
IsItalics Boolean
IsUnderline Boolean

StartRange

procedure StartRange()

EndRange

procedure EndRange()

CreateRange

procedure CreateRange(RangeName: Text[250])

Parameters

Name Type Description
RangeName Text[250]

ClearNewRow

procedure ClearNewRow()

SetUseInfoSheet

procedure SetUseInfoSheet()

UTgetGlobalValue

procedure UTgetGlobalValue(globalVariable: Text[30], var value: Variant)

Parameters

Name Type Description
globalVariable Text[30]
value Variant

SetCurrent

procedure SetCurrent(NewCurrentRow: Integer, NewCurrentCol: Integer)

Parameters

Name Type Description
NewCurrentRow Integer
NewCurrentCol Integer

CreateValidationRule

procedure CreateValidationRule(Range: Code[20])

Parameters

Name Type Description
Range Code[20]

CreateValidationRule

procedure CreateValidationRule(Range: Code[20], SheetName: Text[250])

Parameters

Name Type Description
Range Code[20]
SheetName Text[250]

QuitExcel

procedure QuitExcel()

OpenExcel

procedure OpenExcel()

SetFriendlyFilename

procedure SetFriendlyFilename(Name: Text)

Parameters

Name Type Description
Name Text

ConvertDateTimeDecimalToDateTime

procedure ConvertDateTimeDecimalToDateTime(DateTimeAsOADate: Decimal): DateTime

Parameters

Name Type Description
DateTimeAsOADate Decimal

Returns

Type Description
DateTime

SaveToStream

procedure SaveToStream(var ResultStream: OutStream, EraseFileAfterCompletion: Boolean)

Parameters

Name Type Description
ResultStream OutStream
EraseFileAfterCompletion Boolean

GetSheetsNameListFromStream

procedure GetSheetsNameListFromStream(FileStream: InStream, var TempNameValueBufferOut: Record "Name/Value Buffer" temporary): Boolean

Parameters

Name Type Description
FileStream InStream
TempNameValueBufferOut Table Microsoft.Utilities."Name/Value Buffer"

Returns

Type Description
Boolean

Events

OnAfterAddColumnToBuffer

[IntegrationEvent(False,False)]
local procedure OnAfterAddColumnToBuffer(var ExcelBuffer: Record "Excel Buffer", Value: Variant, IsFormula: Boolean, CommentText: Text, IsBold: Boolean, IsItalics: Boolean, IsUnderline: Boolean, NumFormat: Text[30], CellType: Option)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
Value Variant
IsFormula Boolean
CommentText Text
IsBold Boolean
IsItalics Boolean
IsUnderline Boolean
NumFormat Text[30]
CellType Option

OnBeforeOpenUsingDocumentService

[IntegrationEvent(False,False)]
local procedure OnBeforeOpenUsingDocumentService(FileNameServer: Text, FileName: Text, var Result: Boolean, var IsHandled: Boolean)

Parameters

Name Type Description
FileNameServer Text
FileName Text
Result Boolean
IsHandled Boolean

OnBeforeParseCellValue

[IntegrationEvent(False,False)]
local procedure OnBeforeParseCellValue(var ExcelBuffer: Record "Excel Buffer", var Value: Text, var FormatString: Text, var IsHandled: Boolean)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
Value Text
FormatString Text
IsHandled Boolean

OnBeforeUTgetGlobalValue

[IntegrationEvent(False,False)]
local procedure OnBeforeUTgetGlobalValue(GlobalVariable: Text[30], var Variant_Value: Variant, var IsHandled: Boolean)

Parameters

Name Type Description
GlobalVariable Text[30]
Variant_Value Variant
IsHandled Boolean

OnBeforeWriteCellFormula

[IntegrationEvent(False,False)]
local procedure OnBeforeWriteCellFormula(var Rec: Record "Excel Buffer", var ExcelBuffer: Record "Excel Buffer", var IsHandled: Boolean)

Parameters

Name Type Description
Rec Table System.IO."Excel Buffer"
ExcelBuffer Table System.IO."Excel Buffer"
IsHandled Boolean

OnParseCellValueOnBeforeRoundDecimal

[IntegrationEvent(False,False)]
local procedure OnParseCellValueOnBeforeRoundDecimal(var ExcelBuffer: Record "Excel Buffer", DecimalValue: Decimal, var RoundingPrecision: Decimal)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
DecimalValue Decimal
RoundingPrecision Decimal

OnUpdateBookExcelOnAfterXlWrkBkWriterOpen

[IntegrationEvent(False,False)]
local procedure OnUpdateBookExcelOnAfterXlWrkBkWriterOpen(var ExcelBuffer: Record "Excel Buffer", FileName: Text, SheetName: Text)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
FileName Text
SheetName Text

OnWriteSheetOnBeforeUseXmlTextWriter

[IntegrationEvent(False,False)]
local procedure OnWriteSheetOnBeforeUseXmlTextWriter(var ExcelBuffer: Record "Excel Buffer", var IsHandled: Boolean)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
IsHandled Boolean

OnWriteSheetOnBeforeAddAndInitializeCommentsPart

[IntegrationEvent(False,False)]
local procedure OnWriteSheetOnBeforeAddAndInitializeCommentsPart(var ExcelBuffer: Record "Excel Buffer", var IsHandled: Boolean)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
IsHandled Boolean

OnWriteCellValueOnBeforeSetCellValue

[IntegrationEvent(False,False)]
local procedure OnWriteCellValueOnBeforeSetCellValue(var ExcelBuffer: Record "Excel Buffer", var CellTextValue: Text)

Parameters

Name Type Description
ExcelBuffer Table System.IO."Excel Buffer"
CellTextValue Text

OnBeforeUpdateProgressDialog

[IntegrationEvent(False,False)]
local procedure OnBeforeUpdateProgressDialog(var ExcelBufferDialogManagement: Codeunit "Excel Buffer Dialog Management", var Result: Boolean, var IsHandled: Boolean)

Parameters

Name Type Description
ExcelBufferDialogManagement Codeunit System.IO."Excel Buffer Dialog Management"
Result Boolean
IsHandled Boolean

See also