XlsWorkbook Methods |
The XlsWorkbook type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
Activate |
Obsolete.
Activates the first window associated with the workbook.
|
|
|
AddFont |
Adds font into collection.
|
|
AddReference |
Increase the quantity of reference. User must use this method when
new wrapper on object is created or reference on object stored.
(Inherited from
XlsObject
.)
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
Clone |
Obsolete.
Creates a deep copy of the current workbook.
|
|
|
Close |
Closes the object without saving.
|
|
|
Close(Boolean) |
Closes the object.
|
|
|
Close(String) |
Closes the object and saves changes into specified file.
|
|
|
Close(Boolean, String) |
Closes the object.
|
|
|
ColorDistance |
Calculates distance between two colors.
|
|
|
ContainsFont |
Determines whether the Workbook contains a specific font.
|
|
|
ConvertUnits |
Converts units.
|
|
|
CopyToClipboard |
Obsolete.
Copies the content to the clipboard using the default data format.
|
|
|
CopyToClipboard(XlsWorksheet) |
Obsolete.
Copies the contents of the specified worksheet to the clipboard.
|
|
|
CreateFont |
Method to create a font object and register it in the workbook.
|
|
|
CreateFont(Font) |
Method creates a font object based on native font and register it in the workbook.
|
|
|
CreateFont(IFont) |
Method that creates font object based on another font object
and registers it in the workbook.
|
|
|
CreateFont(IFont, Boolean) |
Creates a new font based on the specified base font.
|
|
|
CreateTemplateMarkersProcessor |
Creates object that can be used for template markers processing.
|
|
|
DecodeName |
Decodes name encoded in supbook.
|
|
|
Dispose |
Releases the unmanaged resources used by the current instance and optionally releases the managed resources.
(Overrides
XlsObject
Dispose
.)
|
|
|
EncodeName |
Encodes a given name by replacing reserved characters and formatting it according to specific rules.
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
FileWidthToPixels |
Converts file width to pixels.
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindAll(Boolean) |
This method seraches for the all cells with specified bool value.
|
|
|
FindAll(DateTime) |
This method seraches for the all cells with specified DateTime value.
|
|
|
FindAll(TimeSpan) |
This method seraches for the all cells with specified TimeSpan value.
|
|
|
FindAll(Double, FindType) |
This method seraches for the all cells with specified double value.
|
|
|
FindAll(String, FindType) |
This method seraches for the all cells with specified string value.
|
|
|
FindOne(Boolean) |
This method seraches for the first cell with specified bool value.
|
|
|
FindOne(DateTime) |
This method seraches for the first cell with specified DateTime value.
|
|
|
FindOne(TimeSpan) |
This method seraches for the first cell with specified TimeSpan value.
|
|
|
FindOne(Double, FindType) |
This method seraches for the first cell with specified double value.
|
|
|
FindOne(String, FindType) |
This method seraches for the first cell with specified string value.
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
GetBookIndex |
Retrieves the index of the book at the specified reference index.
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetMaxDigitWidth |
Returns the maximum digit width of the default font.
|
|
|
GetNearestColor(Color) |
Gets the nearest color to the specified Color structure
from Workbook palette.
|
|
|
GetNearestColor(Color, Int32) |
Gets the nearest color to the specified Color structure
from Workbook palette.
|
|
|
GetNearestColor(Int32, Int32, Int32) |
Gets the nearest color to the specified by red, green, and blue
values color from Workbook palette.
|
|
|
GetPaletteColor |
Method return Color object from workbook palette by its index.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
InitializeCollections |
Initializes the collections used by the class.
|
|
|
IsExternalReference |
Determines if the given reference is an external reference.
|
|
|
IsFormatted |
Determines if the given XF index is formatted.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
Paste |
Obsolete.
Pastes the content from the clipboard to the current context or control.
|
|
|
PixelsToWidth |
Converts pixels to a width value based on the maximum digit width.
|
|
|
Protect(Boolean, Boolean) |
Protects the window and/or content based on the provided parameters.
|
|
|
Protect(Boolean, Boolean, String) |
Protects the workbook based on the provided parameters.
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
Replace(String, DateTime) |
Replaces specified string by specified value.
|
|
|
Replace(String, Double) |
Replaces specified string by specified value.
|
|
|
Replace(String, String) |
Replaces specified string by specified value.
|
|
|
Replace(String, DataColumn, Boolean) |
Replaces specified string by data column values.
|
|
|
Replace(String, DataTable, Boolean) |
Replaces specified string by data table values.
|
|
|
Replace(String, Double , Boolean) |
Replaces specified string by data from array.
|
|
|
Replace(String, Int32 , Boolean) |
Replaces specified string by data from array.
|
|
|
Replace(String, String , Boolean) |
Replaces specified string by data from array.
|
|
|
ResetPalette |
Recover palette to default values.
|
|
|
Save |
Saves changes to the specified workbook.
|
|
|
SaveAs(Stream) |
Saves changes to the specified stream.
|
|
|
SaveAs(String) |
Saves the workbook to a file with the specified file name and save type.
|
|
|
SaveAs(Stream, ExcelSaveType) |
Saves changes to the specified stream.
|
|
|
SaveAs(Stream, String) |
Saves the active sheet to the specified stream using the given separator.
|
|
|
SaveAs(String, ExcelSaveType) |
Saves the workbook as a template or a regular file based on the provided save type.
|
|
|
SaveAs(String, String) |
Saves the current data to a file with the specified file name and separator.
|
|
|
SaveAs(String, HttpResponse) |
Obsolete.
Saves changes to the specified HttpResponse.
|
|
|
SaveAs(Stream, ExcelSaveType, ExcelVersion) |
Saves the workbook to the specified stream with the given save type and version.
|
|
|
SaveAs(String, ExcelSaveType, ExcelVersion) |
Saves the workbook to a file with the specified file name, save type, and Excel version.
|
|
|
SaveAs(String, ExcelSaveType, HttpResponse) |
Saves changes to the specified HttpResponse.
|
|
|
SaveAs(String, String, Boolean) |
Saves the active worksheet to a file with the specified file name, separator, and encoding.
|
|
|
SaveAsEmfStream |
Saves the specified sheet as an EMF stream.
|
|
|
SaveAsHtml |
Obsolete.
Saves the html files.
|
|
|
SaveAsImageOrXps(Stream, FileFormat) |
Saves the workbook as an image or XPS file format to the specified stream.
|
|
|
SaveAsImageOrXps(String, FileFormat) |
Saves the workbook as an image or XPS file.
|
|
|
SaveAsImages(Single, Single) |
Saves the current figure as an array of images with the specified DPI values.
|
|
|
SaveAsImages(Int32, Single, Single) |
Saves the specified sheet as images.
|
|
|
SaveAsImages(Int32, Int32, Int32, Int32, Int32, Single, Single) |
Saves the specified range of cells in the specified sheet as an image.
|
|
|
SaveChartAsEmfImage |
Saves the specified chart as an EMF image.
|
|
|
SaveChartAsImage(ChartSheet, ConverterSetting) |
Saves the chart from the specified chart sheet as an image using the provided image or print options.
|
|
|
SaveChartAsImage(Worksheet, ConverterSetting) |
Saves the chart in the specified worksheet as an image using the provided image or print options.
|
|
|
SaveChartAsImage(Worksheet, Int32, ConverterSetting) |
Saves the chart at the specified index in the worksheet as an image using the provided image or print options.
|
|
|
SaveToPdf(Stream) |
Saves the workbook to a PDF file using the specified stream.
|
|
|
SaveToPdf(String) |
Saves the workbook to a PDF file.
|
|
|
SaveToXlsm(Stream) |
Saves the workbook to an XLSM file format using the specified stream.
|
|
|
SaveToXlsm(String) |
Saves the workbook to an XLSM file.
|
|
|
SetActiveWorksheet |
Sets the active worksheet in the workbook.
|
|
|
SetChanged |
Sets the saved flag to false, indicating that the data has been changed.
|
|
|
SetColorOrGetNearest(Color) |
Sets the specified color or retrieves the nearest available color if the exact color is not available.
|
|
|
SetColorOrGetNearest(Int32, Int32, Int32) |
Sets the specified color using RGB values or retrieves the nearest available color if the exact color is not supported.
|
|
|
SetMaxDigitWidth |
Sets the maximum digit width.
|
|
|
SetPaletteColor |
Set user color for specified element in Color table.
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
SetSeparators |
Obsolete.
Sets the separators used for parsing arguments and array rows.
|
|
|
SetWriteProtectionPassword |
Sets the write protection password for the workbook.
|
|
|
SplitPageInfo |
Splits the page information based on the provided converter settings.
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
Unprotect |
Unprotects the object.
|
|
|
Unprotect(String) |
Unprotects the workbook with the specified password.
|
|
|
WidthToFileWidth |
Converts a width value to a file width value based on a maximum digit width.
|
See Also
