NDoc 1.3.1 SDK

BaseDocumenterConfig.HandleUnknownPropertyValue Method 

When overridden in a derived class, handles a unknown or invalid property value read by Read.

[Visual Basic]
Overridable Protected Function HandleUnknownPropertyValue( _ 
   ByVal property As PropertyInfo, _ 
   ByVal value As String _ 
) As String
protected virtual string HandleUnknownPropertyValue(
   PropertyInfo property,
   string value
protected: virtual String* HandleUnknownPropertyValue(
   PropertyInfo* property,
   String* value
protected virtual function HandleUnknownPropertyValue(
   PropertyInfo property,
   String value
): String;


A valid Property name.
A string representation of the desired property value.

Return Value

A string containing any messages generated by the handler.


As implemented in this class, an error message is returned which details the property name, type and the invalid value.

Notes to Inheritors:    

If a handler can translate the unknown value, it can call the protected method ReadProperty to process to translated name/value.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace