ToAggregateString Method

Definition

Namespace

Codebelt.Unitify

Assemblies

Codebelt.Unitify.dll

Source

src/Codebelt.Unitify/MetricPrefixTable.cs

ToAggregateString(bool, bool, bool)

Returns an aggregated string of all multiple and sub-multiple prefix of this instance.

public string ToAggregateString(bool includeMultiples = true, bool includeSubmultiples = true, bool includeUnit = true)

Parameters

includeMultiples bool

if set to true all multiple prefix is included in the aggregate.

includeSubmultiples bool

if set to true all submultiple prefix is included in the aggregate.

includeUnit bool

if set to true the base unit is included in the aggregate.

Returns

string

An aggregated string of all multiple and sub-multiple prefix of this instance.