Atc.Units.DigitalInformation.md

References  -  References extended

Atc.Units.DigitalInformation

ByteSize

Represents a size in bytes.

public struct ByteSize : IEquatable<ByteSize>

Properties

Value

Value

Summary: Gets the size in bytes.

Methods

Equals

bool Equals(ByteSize other)

Summary: Equals the specified other.

Parameters:
     other  -  The other.

Equals

bool Equals(object obj)

Summary: Equals the specified other.

Parameters:
     other  -  The other.

Format

string Format()

Summary: Returns a System.String that represents this instance.

Returns: A System.String that represents this instance.

Remarks: The size is formatted to a human readable format using the default formatter (Atc.Units.DigitalInformation.ByteSizeFormatter.Default).

Format

string Format(ByteSizeFormatter formatter)

Summary: Returns a System.String that represents this instance.

Returns: A System.String that represents this instance.

Remarks: The size is formatted to a human readable format using the default formatter (Atc.Units.DigitalInformation.ByteSizeFormatter.Default).

GetHashCode

int GetHashCode()

ToString

string ToString()

Summary: Returns a System.String that represents this instance.

Returns: A System.String that represents this instance.

Remarks: The size is formatted to a human readable format using the default formatter (Atc.Units.DigitalInformation.ByteSizeFormatter.Default).

ToString

string ToString(ByteSizeFormatter formatter)

Summary: Returns a System.String that represents this instance.

Returns: A System.String that represents this instance.

Remarks: The size is formatted to a human readable format using the default formatter (Atc.Units.DigitalInformation.ByteSizeFormatter.Default).

ByteSizeFormatter

A formatter that converts a byte size to a human readable string.

public class ByteSizeFormatter

Static Properties

Default

Default

Summary: Returns a default instance of ByteSizeFormatter. This formatter will be used by the ByteSize.ToString() method.

Properties

MaxUnit

MaxUnit

Summary: Gets or sets the largest unit used by the formatter.

MinUnit

MinUnit

Summary: Gets or sets the smallest unit used by the formatter.

NumberFormatInfo

NumberFormatInfo

Summary: Gets or sets the number format information.

NumberOfDecimals

NumberOfDecimals

Summary: Gets or sets the number of decimals.

RoundingRule

RoundingRule

Summary: Gets or sets the rounding rule.

SuffixFormat

SuffixFormat

Summary: Gets or sets a value indicating whether the suffix format should be short or full wording.

Methods

Format

string Format(long size)

Summary: Formats the specified size.

Parameters:
     size  -  The size to format.

Returns: The formatted size.

ByteSizeRoundingRuleType

Defines rounding rules for byte sizes

public enum ByteSizeRoundingRuleType

Value	Name	Description	Summary
0	Closest	Closest	Rounded to the closest value
1	Down	Down	Rounded to the lower value
2	Up	Up	Rounded to the upper value

ByteSizeSuffixType

Enumeration: Format the suffix word.

public enum ByteSizeSuffixType

Value	Name	Description	Summary
0	None	None
1	Short	Short	Short like: KB, GB etc.
2	Full	Full	Full like: Kilobyte, Gigabyte etc.

ByteSizeUnitType

Enumeration: Defines units for byte sizes.

public enum ByteSizeUnitType

Value	Name	Description	Summary
0	Byte	Byte	Byte.
1	Kilobyte	Kilobyte	Kilobyte.
2	Megabyte	Megabyte	Megabyte.
3	Gigabyte	Gigabyte	Gigabyte.
4	Terabyte	Terabyte	Terabyte.
5	Petabyte	Petabyte	Petabyte.
6	Exabyte	Exabyte	Exabyte.

---

Generated by MarkdownCodeDoc version 1.2