Search Results for

    Show / Hide Table of Contents

    Struct DocumentId

    Represents a TopSolid document identifier.

    Implements
    System.IEquatable<DocumentId>
    Inherited Members
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: TopSolid.Kernel.Automating
    Assembly: cs.temp.dll.dll
    Syntax
    [AvailableSinceVersion(7, 6, 0, 0)]
    public struct DocumentId : IEquatable<DocumentId>
    Remarks

    This structure is available since v7.6.

    Constructors

    DocumentId(String)

    Initializes a new instance of the DocumentId structure.

    Declaration
    public DocumentId(string inPdmDocumentId)
    Parameters
    Type Name Description
    System.String inPdmDocumentId

    PDM document identifier, or null if empty.

    Fields

    Empty

    Empty identifier.

    Declaration
    public static readonly DocumentId Empty
    Field Value
    Type Description
    DocumentId

    Properties

    IsEmpty

    Tells whether the document identifier is empty.

    Declaration
    public readonly bool IsEmpty { get; }
    Property Value
    Type Description
    System.Boolean

    PdmDocumentId

    Gets the PDM document identifier.

    Declaration
    public readonly string PdmDocumentId { get; }
    Property Value
    Type Description
    System.String

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object inObject)
    Parameters
    Type Name Description
    System.Object inObject
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    Equals(DocumentId)

    Declaration
    public bool Equals(DocumentId other)
    Parameters
    Type Name Description
    DocumentId other
    Returns
    Type Description
    System.Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    Operators

    Equality(DocumentId, DocumentId)

    Tells whether two document identifiers are equal.

    Declaration
    public static bool operator ==(DocumentId inDocumentId1, DocumentId inDocumentId2)
    Parameters
    Type Name Description
    DocumentId inDocumentId1

    First document identifier.

    DocumentId inDocumentId2

    Second document identifier.

    Returns
    Type Description
    System.Boolean

    Document identifiers are equal.

    Inequality(DocumentId, DocumentId)

    Tells whether two document identifiers are different.

    Declaration
    public static bool operator !=(DocumentId inDocumentId1, DocumentId inDocumentId2)
    Parameters
    Type Name Description
    DocumentId inDocumentId1

    First document identifier.

    DocumentId inDocumentId2

    Second document identifier.

    Returns
    Type Description
    System.Boolean

    Document identifiers are different.

    Implements

    System.IEquatable<T>
    In This Article
    • Mentions légales
    • C.G.U
    • Données personnelles

    Copyright © 2024 TopSolid Tous droits réservés