Field-Map Scripting

4.6.2.3 SetFormula

SetFormula procedure


Prototype:

procedure SetFormula(const row,col :integer; const Formula :string; const Format :string; const FormulaReferenceStyle :string);

Description:

Sets formula for the specified cell

Syntax:

xls.SetFormula(row,col,Formula,Format, FormulaReferenceStyle);  


Part

Description


xls

Variable declared as an instance of the TExcelWrapper class


row

Variable declared as integer that specifies row number


col

Variable declared as integer that specifies column number


Formula

Variable declared as string that specifies formula text, as it is written on Excel.


Format

Variable declared as string that specifies the format name. Default formats are: Default, DefaultCentered, DefaultIndented, DefaultWrapped, DefaultCenteredWrapped, Bold, BoldCentered, ColCaption, ColCaptionItalic, MainTitle, Dec0, Dec1, Dec2, Dec3, Dec4, Dec5, Dec6


FormulaReferenceStyle

Variable declared as string that specifies which reference style to use when entering formulas: A1 or R1C1.

Return value:

none

See also:

SetFormula, GetCellValue, AddImage ,AddImageExt, SetHTML, SetHTMLAndMerge, Complex example


Example:

Var
  Row, Rows:integer;
  v:variant;
  xls :TExcelWrapper;
Begin
  {document preparation}
  //...
  {managing worksheets}
  //...  
  {set cell values examples}
  xls.SetValueAndMerge(Row,4,Row,5,'Species','ColCaption','','');
  inc(Row);
  xls.SetValue(Row,4,'Species ID','ColCaption','','');
  xls.SetValue(Row,5,'Species value','ColCaption','','');
  inc(Row);
  xls.SetValue(Row,4,ValueAsInteger['IDSpecies'],'DEC0','','');
  xls.SetValue(Row,5,ValueAsString['Species'],'TXT','','');
  xls.SetHTML(Row,20,'Volume, m<sup>3</sup>','Dec2','',''); 
  inc(Row)
  //...
  {get cell value example}
  v:=xls.GetCellValue(Row-1,5);
  
  xls.SetValue(Row, 4 , format('Number of trees per plot ID %d: ',[PlotID]), 'TXT','',''); 
  
  {set formula example}
  xls.SetFormula(Row, 5 ,format('=SUM(R[-%d]C:R[-1]C)',[Rows]),'DEC0','R1C1');
  
  {add image example}
  xls.AddImage(ProjectDir+'Pictures\LogoFirmy.png', 6,1,12,20);
  xls.AddImageExt(ProjectDir+'Misc\HlavickaFirmy.png',1,nCol-5,1,nCol,'RIGHT','CENTER',0.02,0.02,0.02,0.02);
  {document saving / previewing}
  //...
End.