LevelAccess.Continuum.AccessibilityConcern Class Reference

This class represents an accessibility concern identified by Access Engine. At minimum, it contains both information about the concern that was identified and well as where on the page the problem is located. It may also include best practice data from AMP, e.g. how severe or noticeable the issue might be, along with an AMP URL that can be visited for more info. More...

Properties
string	Path [get, set]
	Gets a CSS selector to the element with this accessibility concern.
int	EngineTestId [get, set]
	Gets the automatic Access Engine test ID that failed and produced this accessibility concern. Visit the URL returned by BestPracticeDetailsUrl for more information.
string	Attribute [get, set]
	Gets a brief human-readable description of this accessibility concern. Visit the URL returned by BestPracticeDetailsUrl for more information.
string	AttributeDetail [get, set]
	Gets a brief human-readable description of this accessibility concern. Visit the URL returned by BestPracticeDetailsUrl for more information.
int	BestPracticeId [get, set]
	Gets the best practice ID that corresponds to this accessibility concern. Visit the URL returned by BestPracticeDetailsUrl for more information.
string	Element [get, set]
	Gets the source code of the offending HTML node of this accessibility concern. If the presence of an offending element is not applicable to this accessibility concern, this will be null.
int	TestResult [get, set]
	Internal status of a test executed by Access Engine. Used to determine whether an accessibility concern needs review.
FixType	FixType [get, set]
	Gets the remediation steps suggested by Access Engine for resolving this accessibility concern.
bool	NeedsReview [get, set]
	Gets whether or not this accessibility concern requires manual review, i.e. whether the user should manually use AMP to determine whether or not this accessibility concern is actually a legitimate violation given the context of the offending element Element.
Continuum.TestContext	TestContext [get, set]
	Defines the test context in which this accessibility concern was identified, i.e. whether the offending element of this accessibility concern (Element) is an HTML element from a web page (Continuum.TestContext#WEB).
object	RawEngineJsonObject [get, set]
	Gets the raw JSON object from Access Engine that was originally used to build this accessibility concern.
int?	Severity [get, set]
	Gets the severity of this accessibility concern on a scale of 1 to 10, where 1 is the least severe and 10 is the most severe. Visit the URL returned by BestPracticeDetailsUrl for more information.
int?	Noticeability [get, set]
	Gets the noticeability of this accessibility concern on a scale of 1 to 10, where 1 is the least noticeable and 10 is the most noticeable. Visit the URL returned by BestPracticeDetailsUrl for more information.
int?	Tractability [get, set]
	Gets the tractability of this accessibility concern on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable. Visit the URL returned by BestPracticeDetailsUrl for more information.
string	BestPracticeDescription [get, set]
	Gets the name of the best practice that corresponds to this accessibility concern. Visit the URL returned by BestPracticeDetailsUrl for more information.
string	BestPracticeDetailsUrl [get, set]
	Gets the URL of the best practice page in AMP that corresponds to this accessibility concern. An AMP license is not required to visit this URL, but if you're logged into AMP, you'll be presented with additional information beyond what's publicly available.
ISet< Standard >	BestPracticeStandards [get, set]
	Gets the set of accessibility standards associated with the best practice that corresponds to this accessibility concern, ordered alphabetically by name. Visit the URL returned by BestPracticeDetailsUrl for more information.

Detailed Description

This class represents an accessibility concern identified by Access Engine. At minimum, it contains both information about the concern that was identified and well as where on the page the problem is located. It may also include best practice data from AMP, e.g. how severe or noticeable the issue might be, along with an AMP URL that can be visited for more info.

Property Documentation

NeedsReview

bool LevelAccess.Continuum.AccessibilityConcern.NeedsReview

getset

Gets whether or not this accessibility concern requires manual review, i.e. whether the user should manually use AMP to determine whether or not this accessibility concern is actually a legitimate violation given the context of the offending element Element.

If this returns true, visit the URL returned by BestPracticeDetailsUrl for more information on how to manually validate the applicability of this accessibility concern relative to the offending element (Element) it may be that this accessibility concern is not applicable given this context.

Accessibility concerns that require manual review will only ever be returned (and thus this function will only ever possibly return false for a given accessibility concern) if Continuum.GetIncludePotentialAccessibilityConcerns returns true.

---

The documentation for this class was generated from the following file:

• AccessibilityConcern.cs