Skip to main content

SourceLineNumber Class

Represents file name and line number for source file

Methods

MethodDescription
CreateFromEncoded(encodedSourceLineNumbers)Creates a source line number from an encoded string.
CreateFromUri(uri)Creates a source line number from a URI.
CreateFromXObject(node, offset)Creates a source line number from an XObject.
Equals(obj)Determines if two SourceLineNumbers are equivalent.
GetEncoded()Returns the SourceLineNumber and parents encoded as a string.
GetFromXAnnotation(node)Get the source line information for the current element. Typically this information is set by the precompiler for each element that it encounters.
GetHashCode()Serves as a hash code for a particular type.
ToString()Shows a string representation of a source line number.

Properties

PropertyDescription
FileNameGets the file name of the source.
LineNumberGets or sets the line number of the source.
ParentGets or sets the parent source line number that included this source line number.
QualifiedFileNameGets the file name and line information.

WixToolset.Data.dll version 5.0.2+aa65968c419420d32e3e1b647aea0082f5ca5b78

CreateFromEncoded(encodedSourceLineNumbers) Method

Creates a source line number from an encoded string.

Declaration

public static SourceLineNumber CreateFromEncoded(
string encodedSourceLineNumbers
)

Parameters

ParameterTypeDescription
encodedSourceLineNumbersstringEncoded string to parse.

CreateFromUri(uri) Method

Creates a source line number from a URI.

Declaration

public static SourceLineNumber CreateFromUri(
string uri
)

Parameters

ParameterTypeDescription
uristringUri to convert into source line number

CreateFromXObject(node, offset) Method

Creates a source line number from an XObject.

Declaration

public static SourceLineNumber CreateFromXObject(
System.Xml.Linq.XObject node,
int offset
)

Parameters

ParameterTypeDescription
nodeSystem.Xml.Linq.XObjectXML node to create source line number from.
offsetintOptional line number offset into XML file not already included in the line information.

Equals(obj) Method

Determines if two SourceLineNumbers are equivalent.

Declaration

public bool Equals(
System.Object obj
)

Parameters

ParameterTypeDescription
objSystem.ObjectObject to compare.

Return value

bool True if SourceLineNumbers are equivalent.

GetEncoded() Method

Returns the SourceLineNumber and parents encoded as a string.

Declaration

public string GetEncoded()

GetFromXAnnotation(node) Method

Get the source line information for the current element. Typically this information is set by the precompiler for each element that it encounters.

Declaration

public static SourceLineNumber GetFromXAnnotation(
System.Xml.Linq.XObject node
)

Parameters

ParameterTypeDescription
nodeSystem.Xml.Linq.XObjectElement to get source line information for.

Return value

SourceLineNumber The source line number used to author the element being processed or null if the preprocessor did not process the element or the node is not an element.

GetHashCode() Method

Serves as a hash code for a particular type.

Declaration

public int GetHashCode()

Return value

int The hash code.

ToString() Method

Shows a string representation of a source line number.

Declaration

public string ToString()

Return value

string String representation of a source line number.

FileName Property

Gets the file name of the source.

Declaration

public string FileName { get; set; } 

LineNumber Property

Gets or sets the line number of the source.

Declaration

public System.Nullable<System.Int32> LineNumber { get; set; } 

Parent Property

Gets or sets the parent source line number that included this source line number.

Declaration

public SourceLineNumber Parent { get; set; } 

QualifiedFileName Property

Gets the file name and line information.

Declaration

public string QualifiedFileName { get; set; }