New to Telerik Reporting? Start a free 30-day trial

Unit

Class

Represents a length measurement.

Definition

Namespace:Telerik.Reporting.Charting.Styles

Assembly:Telerik.Reporting.dll

Syntax:

[TypeConverter(typeof(UnitConverter))]
public class Unit

Inheritance: objectUnit

Constructors

Unit()

Creates a class instance

public Unit()

Unit(double, UnitType)

Initializes a new instance of the Unit with the specified double precision floating point number and the target type

public Unit(double value, UnitType type)

Parameters:valuedouble

A double precision floating point number that represents the length of the Unit in pixels.

typeUnitType

Unit type

Unit(double)

Initializes a new instance of the Unit with the specified double precision floating point number.

public Unit(double value)

Parameters:valuedouble

A double precision floating point number that represents the length of the Unit in pixels.

Unit(float, UnitType)

Initializes a new instance of the Unit with the specified double precision floating point number and the target type.

public Unit(float value, UnitType type)

Parameters:valuefloat

A float precision floating point number that represents the length of the Unit in pixels.

typeUnitType

Unit type (Pixel / Percentage)

Unit(float)

Initializes a new instance of the Unit with the specified double precision floating point number.

public Unit(float value)

Parameters:valuefloat

A float precision floating point number that represents the length of the Unit in pixels.

Unit(int, UnitType)

Initializes a new instance of the Unit with the specified 32-bit signed integer and the target type

public Unit(int value, UnitType type)

Parameters:valueint

A 32-bit signed integer that represents the length of the Unit in pixels.

typeUnitType

Unit type

Unit(int)

Initializes a new instance of the Unit with the specified 32-bit signed integer.

public Unit(int value)

Parameters:valueint

A 32-bit signed integer that represents the length of the Unit in pixels.

Unit(string, CultureInfo)

Initializes a new instance of the Unit with the specified length.

public Unit(string value, CultureInfo culture)

Parameters:valuestring

A string that represents the length of the Unit.

cultureCultureInfo

CultureInfo

Unit(string)

Initializes a new instance of the Unit with the specified length.

public Unit(string value)

Parameters:valuestring

A string that represents the length of the Unit.

Unit(UnitType)

Creates a class instance

public Unit(UnitType type)

Parameters:typeUnitType

UnitType specifies the target Unit type

Fields

Empty

Unit

Represents an empty Unit. This field is read-only.

public static readonly Unit Empty

Properties

IsEmpty

bool

Gets whether Unit is empty

public bool IsEmpty { get; }

Type

UnitType

Gets or sets the unit type of the Unit.

public UnitType Type { get; set; }

Value

float

Gets or sets the length of the Unit.

public float Value { get; set; }

Methods

Equals(object)

Compares this Unit with the specified object.

public override bool Equals(object obj)

Parameters:objobject

The specified object for comparison.

Returns:

bool

true if the Unit that this method is called from is equal to the specified object; otherwise, false.

Overrides: object.Equals(object)

GetHashCode()

Returns a hash code for this Unit.

public override int GetHashCode()

Returns:

int

Hash code

Overrides: object.GetHashCode()

Parse(string, CultureInfo)

public static Unit Parse(string s, CultureInfo culture)

Parameters:sstringcultureCultureInfoReturns:

Unit

Parse(string)

Converts the specified string to a Unit.

public static Unit Parse(string s)

Parameters:sstring

The string to convert.

Returns:

Unit

A Unit that represents the specified string.

Percentage(double)

Creates a Unit of type Percentage from the specified double-precision floating-point number.

public static Unit Percentage(double n)

Parameters:ndouble

A double-precision floating-point number that represents the length of the Unit

Returns:

Unit

A Unit of type Percentage that represents the length specified by the double-precision floating-point number.

Pixel(float)

Creates a Unit of type Pixel from the specified 32-bit signed integer.

public static Unit Pixel(float n)

Parameters:nfloat

A 32-bit signed integer that represents the length of the Unit.

Returns:

Unit

A Unit of type Pixel that represents the length specified by the n parameter.

ToString()

Base ToString override

public override string ToString()

Returns:

string

String representation of the Unit instance

Overrides: object.ToString()

ToString(CultureInfo)

Base ToString override

public string ToString(CultureInfo culture)

Parameters:cultureCultureInfo

CultureInfo

Returns:

string

String representation of the Unit instance

Operators

implicit operator Unit(float)

Implicitly creates a Unit of type Pixel from the specified float.

public static implicit operator Unit(float n)

Parameters:nfloat

A float that represents the length of the Unit.

Returns:

Unit

A Unit of type Pixel that represents the specified by the n parameter.

operator !=(Unit, Unit)

Compares two Unit objects to determine whether they are not equal.

public static bool operator !=(Unit left, Unit right)

Parameters:leftUnit

The Unit on the left side of the operator.

rightUnit

The Unit on the right side of the operator.

Returns:

bool

true if the Unit objects are not equal; otherwise, false.

operator ==(Unit, Unit)

Compares two Unit objects to determine whether they are equal.

public static bool operator ==(Unit left, Unit right)

Parameters:leftUnit

The Unit on the left side of the operator.

rightUnit

The Unit on the right side of the operator.

Returns:

bool

true if both Unit objects are equal; otherwise, false.