API Reference
DocumentationControl
Informational control that carries vendor documentation only (no evaluation/write). Useful to surface DocOnly baseline rows in cmdlets and UIs.
Inheritance
- Object
- DocumentationControl
Constructors
public DocumentationControl(String id, String title) #Creates a documentation-only control with an id and title.
Parameters
- id System.String
- title System.String
Methods
public virtual CxEval Evaluate(String host, CxFacts facts) #CxEvalReturns a pass result with vendor desired values for display.
Parameters
- host System.String
- facts ComputerX.Controls.CxFacts
public virtual Boolean IsApplicable(CxFacts facts) #BooleanReturns true for all inputs (documentation-only control).
Parameters
- facts ComputerX.Controls.CxFacts
public virtual Object ReadCurrent(String host, CxFacts facts) #ObjectReturns the current value (description or title) for display.
Parameters
- host System.String
- facts ComputerX.Controls.CxFacts
public virtual Boolean TryWrite(String host, Object value, out String error) #BooleanAlways returns false; documentation-only controls cannot write.
Parameters
- host System.String
- value System.Object
- error System.String@
public DocumentationControl WhereIs(CxCondition c) #DocumentationControlSets an applicability condition for the control.
Parameters
- c ComputerX.Controls.CxCondition
public DocumentationControl WithMetadata(String description, String referenceUrl, String severity, String category, String[] tags) #DocumentationControlAttaches optional metadata and infers a vendor source from tags.
Parameters
- description System.String
- referenceUrl System.String
- severity System.String
- category System.String
- tags System.String[]
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public virtual String Id { get; } #Unique identifier for the control.
public virtual String Title { get; } #Short title for the documentation item.
public String Description { get; set; } #Optional descriptive text.
public String ReferenceUrl { get; set; } #Optional reference URL (CIS/STIG/MSB page, blog, KB, etc.).
public String Severity { get; set; } #Optional severity label (Informational/Low/Medium/High).
public String Category { get; set; } #Optional category label.
public virtual CxValueKind ValueKind { get; } #Value kind reported by the control (always string for DocOnly).
public virtual CxComparator Comparator { get; } #Comparator semantics (always Exact for DocOnly).
public virtual IReadOnlyList<CxDesired> Desired { get; } #Desired target values by vendor source (CIS/STIG/MSB/Custom).
public CxCondition Where { get; set; } #Optional applicability condition.