Daniel's XL Toolbox NG
XLToolbox.Excel.Models.RangeHelperBase Class Referenceabstract

Base class for the helper classes RowHelper and RangeHelper More...

Inheritance diagram for XLToolbox.Excel.Models.RangeHelperBase:
Collaboration diagram for XLToolbox.Excel.Models.RangeHelperBase:

Public Member Functions

void ToggleFixed ()
 
override string ToString ()
 
int CompareTo (object obj)
 

Static Public Member Functions

static bool operator< (RangeHelperBase one, RangeHelperBase other)
 
static bool operator<= (RangeHelperBase one, RangeHelperBase other)
 
static bool operator> (RangeHelperBase one, RangeHelperBase other)
 
static bool operator>= (RangeHelperBase one, RangeHelperBase other)
 

Protected Member Functions

abstract string FormatNumber (long number)
 Returns a number formatted as a string. More...
 
abstract long ParseNumber (string formatted)
 Parses a formatted reference string. More...
 

Properties

string Reference [get, set]
 
string UnfixedReference [get]
 
string FixedReference [get]
 
bool IsFixed [get, set]
 
long Number [get, set]
 

Detailed Description

Base class for the helper classes RowHelper and RangeHelper

Member Function Documentation

◆ CompareTo()

int XLToolbox.Excel.Models.RangeHelperBase.CompareTo ( object  obj)
inline

◆ FormatNumber()

abstract string XLToolbox.Excel.Models.RangeHelperBase.FormatNumber ( long  number)
protectedpure virtual

Returns a number formatted as a string.

Parameters
numberNumber to format.
Returns
Formatted string.

Implemented in XLToolbox.Excel.Models.ColumnHelper, and XLToolbox.Excel.Models.RowHelper.

◆ operator<()

static bool XLToolbox.Excel.Models.RangeHelperBase.operator< ( RangeHelperBase  one,
RangeHelperBase  other 
)
inlinestatic

◆ operator<=()

static bool XLToolbox.Excel.Models.RangeHelperBase.operator<= ( RangeHelperBase  one,
RangeHelperBase  other 
)
inlinestatic

◆ operator>()

static bool XLToolbox.Excel.Models.RangeHelperBase.operator> ( RangeHelperBase  one,
RangeHelperBase  other 
)
inlinestatic

◆ operator>=()

static bool XLToolbox.Excel.Models.RangeHelperBase.operator>= ( RangeHelperBase  one,
RangeHelperBase  other 
)
inlinestatic

◆ ParseNumber()

abstract long XLToolbox.Excel.Models.RangeHelperBase.ParseNumber ( string  formatted)
protectedpure virtual

Parses a formatted reference string.

This method is called by the Reference setter which will strip a dollar sign (if present) from the formatted string first.

Parameters
formattedString containing a formatted number.
Returns
Number read from the string.

Implemented in XLToolbox.Excel.Models.ColumnHelper, and XLToolbox.Excel.Models.RowHelper.

◆ ToggleFixed()

void XLToolbox.Excel.Models.RangeHelperBase.ToggleFixed ( )
inline

◆ ToString()

override string XLToolbox.Excel.Models.RangeHelperBase.ToString ( )
inline

Property Documentation

◆ FixedReference

string XLToolbox.Excel.Models.RangeHelperBase.FixedReference
get

◆ IsFixed

bool XLToolbox.Excel.Models.RangeHelperBase.IsFixed
getset

◆ Number

long XLToolbox.Excel.Models.RangeHelperBase.Number
getset

◆ Reference

string XLToolbox.Excel.Models.RangeHelperBase.Reference
getset

◆ UnfixedReference

string XLToolbox.Excel.Models.RangeHelperBase.UnfixedReference
get

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