Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

Copies an area of cells from another Worksheet to cells in this worksheet.

Signature
C#
C#
 public Area CopyPaste(Cell destCell, Area sourceArea, CopyPasteProperties properties)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Function CopyPaste(ByVal destCell As Cell, ByVal sourceArea As Area, ByVal properties As CopyPasteProperties) As Area
{signature}
{parameters}
{param:destCell}A [Cell|Cell] indicating the upper\-left cell of the destination area.{param}
{param:sourceArea}An area from the source workbook from which to copy.{param}
{param:properties}A [CopyPasteProperties|CopyPasteProperties] object that specifies the types of data to copy.{param}
{returns}An [Area|Area] object representing the set of cells populated with the copied values.{returns}
{remarks}
The copied data will +overwrite+ the contents of the cells in this worksheet.  You may specify the types of data copied \(cell value, formulas, comments, formatting, etc.\) using the CopyPasteProperties object.
{remarks}
{example}{code:csharp|title=C#}
Parameters
Param
destCell
destCell

A Cell indicating the upper-left cell of the destination area.

Param
sourceArea
sourceArea

An area from the source workbook from which to copy.

Param
properties
properties

A CopyPasteProperties object that specifies the types of data to copy.

Returns

An Area object representing the set of cells populated with the copied values.

Remarks

The copied data will overwrite the contents of the cells in this worksheet. You may specify the types of data copied (cell value, formulas, comments, formatting, etc.) using the CopyPasteProperties object.

Example
Code Block
csharp
csharp
titleC#


          //--- Open the workbook and worksheet from which we will copy cells.
          Workbook sourceWb = xla.Open("MyDataSource.xls");
          Worksheet sourceWs = sourceWb[0];

          //--- Create the workbook and and get the worksheet
          //--- into which we will paste cells.
          Workbbok destWb = xla.Create("MyNewWorkbook");
          Worksheet destWs = destWb[0];

          //--- Define the area of cells to copy.
          Area srcArea = sourceWs.CreateArea("A1:F20");

          //--- Copy cell values, formulas and cell and number formatting.
          CopyPasteProperties copyPasteProps =
               sourceWb.CreateCopyPasteProperties(
               CopyPasteProperties.CopyPasteType.ValueFormulasAndFormatting);

          //--- Paste the data onto the destination worksheet.
          Cell whereToPaste = destSheet["A1"];
          destWs.CopyPaste(whereToPaste, srcArea, copyPasteProps);
        
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}


          '--- Open the workbook and worksheet from which we will copy cells.
          Dim sourceWb As Workbook = xla.Open("MyDataSource.xls")
          Dim sourceWs As Worksheet = sourceWb(0)

          '--- Create the workbook and and get the worksheet
          '--- into which we will paste cells.
          Dim destWb As Workbook = xla.Create("MyNewWorkbook")
          Dim destWs As Worksheet = destWb(0)

          '--- Define the area of cells to copy.
          Dim srcArea As Area = sourceWs.CreateArea("A1:F20")

          '--- Copy cell values, formulas and cell and number formatting.
          Dim whereToPaste As Cell = destSheet("A1")
          Dim copyPasteProps As CopyPasteProperties = _
               sourceWb.CreateCopyPasteProperties( _
               CopyPasteProperties.CopyPasteType.ValueFormulasAndFormatting)

          '--- Paste the data onto the destination worksheet.
          destWs.CopyPaste("A1", srcArea, copyPasteProps)
        
{code} {example}