FormatDescription Method

In This Topic

Allows the formatting of the log message description to be overridden.

Syntax

Visual Basic
C#

'Declaration
 
Protected Overridable Function FormatDescription( _
   ByVal context As PostSharp.Aspects.LocationInterceptionArgs, _
   ByVal previousValue As Object, _
   ByVal newValue As Object _
) As String

protected virtual string FormatDescription( 
   PostSharp.Aspects.LocationInterceptionArgs context,
   object previousValue,
   object newValue
)

Parameters

context: The PostSharp location interception arguments.
previousValue: The value that the field is being changed from.
newValue: The value that the field is being changed to.

Return Value

A substitute description to use instead of the default generated description.

Remarks

By overriding this method you can implement your own custom description formatting for log messages in GField. Captions are generally short and often don't contain any insertion strings. Descriptions are designed for longer values and are shown in the Log Message Detail section of Gibraltar Analyst, along with the Caption (so it is not desirable to duplicate the caption in the description).

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GField Class
GField Members

Send Feedback