Class UnknownSourceInfo

Implementation of IDocumentSourceInfo for a document which has an unidentifiable source.

Inheritance
System.Object
UnknownSourceInfo
Implements
System.IEquatable<IDocumentSourceInfo>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: ZptSharp.Rendering
Assembly: ZptSharp.Abstractions.dll
Syntax
public sealed class UnknownSourceInfo : IDocumentSourceInfo, IEquatable<IDocumentSourceInfo>
Remarks

This class is used when (for any reason) the source information is not provided. This typically means that either an optional parameter was omitted, or a null was explicitly passed. Instances of this type will always indicate that the source is <unknown> and are only equal in the case that they are reference equal.

Properties

| Improve this Doc View Source

Name

Gets the name of the source, which for this type will always return the string <unknown>.

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

The name of the document source.

Methods

| Improve this Doc View Source

Equals(IDocumentSourceInfo)

Determines whether the specified IDocumentSourceInfo is equal to the current UnknownSourceInfo. Will only return true if the objects are reference-equal.

Declaration
public bool Equals(IDocumentSourceInfo other)
Parameters
Type Name Description
IDocumentSourceInfo other

The IDocumentSourceInfo to compare with the current UnknownSourceInfo.
Returns
Type Description
System.Boolean

true if the specified IDocumentSourceInfo is equal to the current UnknownSourceInfo; otherwise, false.
| Improve this Doc View Source

ToString()

Returns a System.String that represents the current UnknownSourceInfo. For this type, it will always return the string <unknown>.

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

A System.String that represents the current UnknownSourceInfo.
Overrides
System.Object.ToString()

Implements

System.IEquatable<T>