RtfComplianceIssue Structure

An RTF compliance issue detected while converting.

Definition

Namespace: MimeKit.Text
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public readonly struct RtfComplianceIssue : IEquatable<RtfComplianceIssue>
Inheritance
Object    ValueType    RtfComplianceIssue
Implements
IEquatableRtfComplianceIssue

Remarks

Describes a single deviation from the Rich Text Format (RTF) Specification along with the location within the document where it was detected.

New properties may be added to this structure in future versions of MimeKit in order to provide richer context about a violation. For that reason, always construct instances using one of the available constructors rather than relying on the default value.

The default value of this structure has a Violation of None, which is never reported and cannot be constructed, so it may be used to detect an uninitialized instance.

Constructors

RtfComplianceIssue Initialize a new instance of the RtfComplianceIssue struct.

Properties

Categories Get the categories of harm that the RTF compliance violation may cause.
Depth Get the group nesting depth where the violation was found.
Description Get a brief description of the RTF compliance violation.
LineNumber Get the line number where the violation was found.
LinePosition Get the position within the line where the violation was found.
Offset Get the character offset within the document where the violation was found.
Remarks Get a detailed explanation of the RTF compliance violation.
Severity Get the severity of the RTF compliance violation.
Violation Get the specific RTF compliance violation that occurred.

Methods

Equals(Object) Determine whether the specified Object is equal to the current RtfComplianceIssue.
(Overrides ValueTypeEquals(Object))
Equals(RtfComplianceIssue) Determine whether the specified RtfComplianceIssue is equal to the current RtfComplianceIssue.
GetCategories Get the categories of harm that an RTF compliance violation may cause.
GetDescription Get a brief description of an RTF compliance violation.
GetHashCode Serve as a hash function for a RtfComplianceIssue object.
(Overrides ValueTypeGetHashCode)
GetRemarks Get a detailed explanation of an RTF compliance violation.
GetSeverity Get the severity of an RTF compliance violation.
GetType Gets the Type of the current instance.
(Inherited from Object)
ToString Get a string representation of the RTF compliance issue.
(Overrides ValueTypeToString)

Operators

Equality(RtfComplianceIssue, RtfComplianceIssue) Compare two RtfComplianceIssue objects for equality.
Inequality(RtfComplianceIssue, RtfComplianceIssue) Compare two RtfComplianceIssue objects for inequality.

See Also