Class FileSourceInfo

Implementation of IDocumentSourceInfo for a document which was retrieved from a file on disk.

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

Constructors

| Improve this Doc View Source

FileSourceInfo(String)

Initializes a new instance of the FileSourceInfo class.

Declaration
public FileSourceInfo(string filePath)
Parameters
Type Name Description
System.String filePath

The file path.

Properties

| Improve this Doc View Source

FilePath

Gets the file path.

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

The file path.
| Improve this Doc View Source

Name

Gets the name of the source.

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

The name of the document source.

Methods

| Improve this Doc View Source

Equals(Object)

Determines whether the specified System.Object is equal to the current FileSourceInfo.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object to compare with the current FileSourceInfo.
Returns
Type Description
System.Boolean

true if the specified System.Object is equal to the current FileSourceInfo; otherwise, false.
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

Equals(IDocumentSourceInfo)

Determines whether the specified IDocumentSourceInfo is equal to the current FileSourceInfo.

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

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

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

GetContainer()

Gets the parent/container object, in this case representing a System.IO.DirectoryInfo.

Declaration
public object GetContainer()
Returns
Type Description
System.Object

The container.
| Improve this Doc View Source

GetHashCode()

Serves as a hash function for a FileSourceInfo object.

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

A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

ToString()

Returns a System.String that represents the current FileSourceInfo.

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

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

Implements

System.IEquatable<T>