Class Suggestion

Suggestion class represents a suggestion that describes a change that can be made to a document by replacing the existing markup between the from location and upto location with the suggestion markup.

Inheritance

System.Object

Suggestion

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sdl.Verification.Api

Assembly: Sdl.Verification.Api.dll

Syntax

public class Suggestion

Constructors

Suggestion(IMessageLocation, IMessageLocation, IAbstractMarkupData)

Constructor that takes the from location, upto location, and suggestion markup.

Declaration

public Suggestion(IMessageLocation fromLocation, IMessageLocation uptoLocation, IAbstractMarkupData suggestionMarkup)

Parameters

Type	Name	Description
IMessageLocation	fromLocation	from location
IMessageLocation	uptoLocation	upto location
IAbstractMarkupData	suggestionMarkup	suggestion markup - set suggestionMarkup to null to suggest deleting the existing markup between the from location and the upto location

Properties

FromLocation

FromLocation property represents the "start" location of the existing markup to be replaced.

Declaration

public IMessageLocation FromLocation { get; }

Property Value

Type	Description
IMessageLocation

SuggestionMarkup

SuggestionMarkup property represents the suggestion markup to replace the existing markup.

Declaration

public IAbstractMarkupData SuggestionMarkup { get; }

Property Value

Type	Description
IAbstractMarkupData

UptoLocation

UptoLocation property represents the "finish" location of the existing markup to be replaced.

Declaration

public IMessageLocation UptoLocation { get; }

Property Value

Type	Description
IMessageLocation