XLToolbox.Excel.Models.Reference Class Reference

View model for Excel ranges. More...

Inheritance diagram for XLToolbox.Excel.Models.Reference:

Collaboration diagram for XLToolbox.Excel.Models.Reference:

Public Member Functions
void	Activate ()
void	MakeFixed ()
void	MakeUnfixed ()
void	ToggleFixed ()
	Reference ()
	Reference (string reference)
	Reference (Range range)
void	Dispose ()
override string	ToString ()
	Returns the fully qualified reference string for the Range, including the Workbook name and the path to the workbook if the workbook has been saved previously. More...

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
string	WorkbookPath [get, set]
	Gets or sets the FullName of the workbook. More...
string	SheetName [get, set]
string	Address [get, set]
string	FixedAddress [get]
string	UnfixedAddress [get]
string	ReferenceString [get, set]
	Gets or sets the fully qualified Excel reference. More...
bool	IsValid [get]
	Gets whether the reference is formally valid. Does not check whether the references workbook and worksheet actually exist. More...
Range	Range [get, set]
	Gets or sets the range. More...
Range	Rows [get]
	Gets the Rows object for the Range. This COM object will be released when the view model is disposed. More...
Range	Cols [get]
	Gets the Columns object for the Range. This COM object will be released when the view model is disposed. More...
long	CellCount [get]
	Computes the number of cells in the Range; the value is cached. More...
RowHelper	Top [get]
RowHelper	Bottom [get]
ColumnHelper	Left [get]
ColumnHelper	Right [get]
bool	IsRectangle [get]

Detailed Description

View model for Excel ranges.

Constructor & Destructor Documentation

Reference() [1/3]

XLToolbox.Excel.Models.Reference.Reference ( )

inline

Reference() [2/3]

XLToolbox.Excel.Models.Reference.Reference ( string  reference )

inline

Reference() [3/3]

XLToolbox.Excel.Models.Reference.Reference ( Range  range )

inline

Member Function Documentation

Activate()

void XLToolbox.Excel.Models.Reference.Activate ( )

inline

Dispose() [1/2]

void XLToolbox.Excel.Models.Reference.Dispose ( )

inline

Dispose() [2/2]

virtual void XLToolbox.Excel.Models.Reference.Dispose ( bool  disposing )

inlineprotectedvirtual

MakeFixed()

void XLToolbox.Excel.Models.Reference.MakeFixed ( )

inline

MakeUnfixed()

void XLToolbox.Excel.Models.Reference.MakeUnfixed ( )

inline

ToggleFixed()

void XLToolbox.Excel.Models.Reference.ToggleFixed ( )

inline

ToString()

override string XLToolbox.Excel.Models.Reference.ToString ( )

inline

Returns the fully qualified reference string for the Range, including the Workbook name and the path to the workbook if the workbook has been saved previously.

Passes the request to GetFullyQualifiedReference().

Returns

Reference string for the Range

Property Documentation

Address

string XLToolbox.Excel.Models.Reference.Address

getset

Bottom

RowHelper XLToolbox.Excel.Models.Reference.Bottom

get

CellCount

long XLToolbox.Excel.Models.Reference.CellCount

get

Computes the number of cells in the Range; the value is cached.

Cols

Range XLToolbox.Excel.Models.Reference.Cols

get

Gets the Columns object for the Range. This COM object will be released when the view model is disposed.

FixedAddress

string XLToolbox.Excel.Models.Reference.FixedAddress

get

IsRectangle

bool XLToolbox.Excel.Models.Reference.IsRectangle

get

IsValid

bool XLToolbox.Excel.Models.Reference.IsValid

get

Gets whether the reference is formally valid. Does not check whether the references workbook and worksheet actually exist.

Left

ColumnHelper XLToolbox.Excel.Models.Reference.Left

get

Range

Range XLToolbox.Excel.Models.Reference.Range

getset

Gets or sets the range.

ReferenceString

string XLToolbox.Excel.Models.Reference.ReferenceString

getset

Gets or sets the fully qualified Excel reference.

Right

ColumnHelper XLToolbox.Excel.Models.Reference.Right

get

Rows

Range XLToolbox.Excel.Models.Reference.Rows

get

Gets the Rows object for the Range. This COM object will be released when the view model is disposed.

SheetName

string XLToolbox.Excel.Models.Reference.SheetName

getset

Top

RowHelper XLToolbox.Excel.Models.Reference.Top

get

UnfixedAddress

string XLToolbox.Excel.Models.Reference.UnfixedAddress

get

WorkbookPath

string XLToolbox.Excel.Models.Reference.WorkbookPath

getset

Gets or sets the FullName of the workbook.

---

The documentation for this class was generated from the following file:

• XLToolbox/Excel/Models/Reference.cs