Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class LabelAndValue

    Single label and its value, usually contained in a FacetResult.

    Inheritance
    System.Object
    LabelAndValue
    Implements
    System.IFormattable
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Lucene.Net.Facet
    Assembly: Lucene.Net.Facet.dll
    Syntax
    public sealed class LabelAndValue : IFormattable

    Constructors

    | Improve this Doc View Source

    LabelAndValue(String, Int32)

    Constructor for System.Int32 value. Makes the ToString() method print the value as an System.Int32 with no decimal.

    Declaration
    public LabelAndValue(string label, int value)
    Parameters
    Type Name Description
    System.String label
    System.Int32 value
    | Improve this Doc View Source

    LabelAndValue(String, Single)

    Constructor for System.Single value. Makes the ToString() method print the value as a System.Single with at least 1 number after the decimal.

    Declaration
    public LabelAndValue(string label, float value)
    Parameters
    Type Name Description
    System.String label
    System.Single value

    Properties

    | Improve this Doc View Source

    Label

    Facet's label.

    Declaration
    public string Label { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    TypeOfValue

    The original data type of Value that was passed through the constructor.

    Declaration
    public Type TypeOfValue { get; }
    Property Value
    Type Description
    System.Type
    | Improve this Doc View Source

    Value

    Value associated with this label.

    Declaration
    public float Value { get; }
    Property Value
    Type Description
    System.Single

    Methods

    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object other)
    Parameters
    Type Name Description
    System.Object other
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Object.Equals(System.Object)
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Object.GetHashCode()
    | Improve this Doc View Source

    ToString()

    Converts the value of this instance to its equivalent string representation.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    The string representation of the label and value of this instance.

    Overrides
    System.Object.ToString()
    | Improve this Doc View Source

    ToString(IFormatProvider)

    Converts the value of this instance to its equivalent string representation using the specified culture-specific format information.

    Declaration
    public string ToString(IFormatProvider provider)
    Parameters
    Type Name Description
    System.IFormatProvider provider
    Returns
    Type Description
    System.String

    The string representation of the label and value of this instance as specified by provider.

    Explicit Interface Implementations

    | Improve this Doc View Source

    IFormattable.ToString(String, IFormatProvider)

    Declaration
    string IFormattable.ToString(string format, IFormatProvider provider)
    Parameters
    Type Name Description
    System.String format
    System.IFormatProvider provider
    Returns
    Type Description
    System.String

    Implements

    System.IFormattable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.