Chat Support
Loupe - Log - Monitor - Resolve
Gibraltar.Agent.PostSharp Namespace / GField Class / FormatCaption Method
The PostSharp location interception arguments.
The value that the field is being changed from.
The value that the field is being changed to.

In This Topic
FormatCaption Method
In This Topic
Allows the formatting of the log message caption to be overridden.
Syntax
'Declaration
 

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

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 caption to use instead of the default generated caption.
Remarks
By overriding this method you can implement your own custom caption formatting for log messages in GField. Captions are generally short and often don't contain any insertion strings. Captions show in the main body of the message viewer. For longer values use FormatDescription which is designed for extended data.
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

See Also

Reference

GField Class
GField Members

 

 

Copyright © 2008-2024 Gibraltar Software, Inc.

Send Feedback