ExcelExplorer Pro Manual

ExcelExplorer Manual
Class Reference
Prev
Class Reference
Next
Class hierarchy

Chapter 12. List of all available classes

This page contains a complete list of all available classes and it's methods.


Class: ExcelExplorer

Main class. This is the only class that can be directly used (i.e. created by the new() operator in external application).

Methods

Version - Get current ExcelExplorer version
ExploreFile - Read data from a binary Excel file
ExploreString - Read data from string that contains readed Excel file
ExploreWorksheet - Read data from a specified worksheet
WorksheetsNum - Returns number of defined worksheets
Worksheet - Get EEWorksheet object for the specified worksheet
Column - Get EEColumn object for the specified column
Row - Get EERow object for the specified row
Cell - Get EECell object for the specified cell
false Style - Get EEStyle object for the style with specified index
StylesList - Returns styles array (array of EEStyle objects) for all defined styles
false Font - Get EEFont object for the font with specified index
FontsList - Returns fonts array (array of EEFont objects) for all defined fonts
false Format - Get EEFormat object for the format with specified index
FormatsList - Returns formats array (array of EEFormat objects) for all defined formats
false Image - Get EEImage object for the image with specified index
ImagesList - Returns images array (array of EEImage objects) for all defined images
SummaryInformation - Returns summary information of the document
Helper - Returns object of EEHelper class


Class: EEWorksheet

Class to operate worksheets.

Methods

Type - Get worksheet type
Title - Get worksheet title
Hidden - Returns worksheet visibility
Defined - Returns whether worksheet is defined (exists) or not
IsEmpty - Returns whether worksheet exists and contains any data or not
false DefinedArea - Returns defined area in the current sheet (area contains defined columns, rows, or cells - even blank)
false UsedArea - Returns used area in the current sheet (area contains cells with data)
Column - Get EEColumn object for the specified column
Row - Get EERow object for the specified row
Cell - Get EECell object for the specified cell
ShapesNum - Returns number of shapes defined in the worksheet
false Shape - Get EEShape object for the specified shape


Class: EEColumn

Class to operate columns.

Methods

Width - Get column width
Hidden - Get column visibility
Level - Get column grouping level
IsEmpty - Returns whether column is empty (contains at least one cell with actual data) or not
Cell - Get EECell object for the specified cell


Class: EERow

Class to operate rows.

Methods

Height - Get row height
Hidden - Get row visibility
Level - Get row grouping level
IsEmpty - Returns whether row is empty (contains at least one cell with actual data) or not
Cell - Get EECell object for the specified cell


Class: EECell

Class to operate cells.

Methods

Type - Get cell type
PlainData - Returns unformatted cell data
Data - Returns formatted cell data
Style - Get cell style
false Link - Returns hyperlink assigned to the cell if any
false Merged - Returns merged cells area


Class: EEData

Class to operate data of different types used in MS Excel.

Methods

IsUnicode - Returns what coding used for the data - 16-bit Unicode or 8-bit
Plain - Returns data unmodified
HTML - Convert data to well-formatted HTML string
UTF8 - Returns data in UTF-8 coding
IsRichText - Returns whether string contains any rich text parts or not
false RichText - Returns rich text settings for the string, if any
IsPhonetic - Returns whether asian phonetic data found for the string
false Phonetic - Returns phonetic data if any


Class: EEDataRichText

Class that holds data of one rich text part (string and font)

Methods

Data - Returns string data of this rich text part
false Font - Returns font used by this rich text part


Class: EEDataPhonetic

Class that holds one part of the asian phonetic data.

Methods

Data - Get base text
false Phonetic - Returns phonetic string, if any
false Font - Get font used for phonetic text
Align - Get phonetic text alignment
Type - Returns phonetic text type


Class: EEStyle

Class that holds style information.

Methods

Index - Get style index
false Font - Get EEFont object containing font data
false Format - Get format info (EEFormat object)
false Align - Returns data alignment
false BackgroundColor - Get background color
false Borders - Get borders styles and colors


Class: EEFont

Class that holds font info.

Methods

Index - Get font index
Name - Get font name
Height - Get font height (size)
Size - Alias for Height()
Weight - Get font weight (boldness)
Bold - Alias for Weight()
Italic - Returns whether font use normal or italic style
Strike - Returns whether characters are struck out
Script - Get font escapement type (normal, superscript, subscript)
Underline - Get font underline type
false Color - Get font color


Class: EEFormat

Class that holds format info. Used for date/time, percentage, scientific and others formats.

Methods

Index - Get format index
false String - Get format string


Class: EEColor

Class that holds color info.

Methods

Red - Get red component of the color
Green - Get green component of the color
Blue - Get blue component of the color
HTML - Get HTML string represents color, e.g. #123456


Class: EEAlign

Class that holds alignment info.

Methods

HAlign - Get horizontal alignment
VAlign - Get vertical alignment
WordWrap - Returns whether word-wrapping enabled or not


Class: EEBorders

Class that holds borders info.

Methods

Left - Get left border
Right - Get right border
Top - Get top border
Bottom - Get bottom border
DiagLBRT - Get diagonal border (from left-bottom to right-top)
DiagLTRB - Get diagonal border (from left-top to right-bottom)


Class: EEBorder

Class that holds individual border info.

Methods

Style - Get border style
false Color - Get border color


Class: EEArea

Class that holds data about cells area.

Methods

FirstColumn - Get leftmost column index of the cells area
FirstRow - Get topmost row index of the cells area
LastColumn - Get rightmost column index of the cells area
LastRow - Get bottommost row index of the cells area
Width - Width, in columns, of the cells area
Height - Height, in rows, of the cells area


Class: EELink

Class that hold hyperlink's data.

Methods

Type - Get hyperlink type
Absolute - Returns whether hyperlink contains absolute URL or file path
Link - Get hyperlink's URL or file path
false TextMark - Get anchor for the URL string (symbols after # sign) or link within workbook
false Target - Get target frame, if any
false QuickTip - Returns quick tip (hint) for the hyperlink, if any


Class: EEImage

Class that holds image info and the image data.

Methods

Index - Get image index
Type - Get image type
Data - Get image data


Class: EEShape

Class that holds information about image (position, width, height, etc.).

Methods

Index - Returns shape index
ImageIndex - Get image index used in the shape
LeftOffset - Returns offset position of left shape border within a sheet
StartColumn - Returns column index that contains left border of the shape
ColumnOffset - Returns offset position of the left shape border within starting column
TopOffset - Returns offset position of top shape border within a sheet
StartRow - Returns row index that contains top border of the shape
RowOffset - Returns offset position of the top shape border within starting row
Width - Returns shape width
Height - Returns shape height


Class: EEHelper

Helper class containing some useful functions.

Methods

Number2Date - Convert number to a date using Excel algorithm
CSSBorderStyle - Returns string representing border style that can be directly used in CSS/HTML
Ch2Px - Converts character count units to the pixels
Tw2Pt - Converts logical twips units to the printer points
Tw2In - Converts logical twips units to the inches
Pt2In - Converts printer points to the inches


ExcelExplorer Manual
Class Reference
Prev
Class Reference
Next
Class hierarchy