OPC Studio User's Guide and Reference
Format Method (UADataSetHeaderControl)



OpcLabs.EasyOpcForms Assembly > OpcLabs.EasyOpc.UA.Forms.PubSub Namespace > UADataSetHeaderControl Class : Format Method
The date/time to be formatted.
Determines whether the formatted string is intended for display in a tooltip.
Infrastructure. Formats the date/time for display, according to control settings.
Syntax
'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Protected Function Format( _
   ByVal dateTime As Date, _
   ByVal forTooltip As Boolean _
) As String
'Usage
 
Dim instance As UADataSetHeaderControl
Dim dateTime As Date
Dim forTooltip As Boolean
Dim value As String
 
value = instance.Format(dateTime, forTooltip)
[NotNull()]
[Pure()]
protected string Format( 
   DateTime dateTime,
   bool forTooltip
)
[NotNull()]
[Pure()]
protected:
String^ Format( 
   DateTime dateTime,
   bool forTooltip
) 

Parameters

dateTime
The date/time to be formatted.
forTooltip
Determines whether the formatted string is intended for display in a tooltip.

Return Value

Returns the dateTime formatted for display in the control.

This method never returns null (Nothing in Visual Basic).

Remarks

The format of timestamps in tooltips complements the format used by the control on its main display. That is, when the control is set to display the timestamps in precise format, the dates in tooltips are formatted normally, and vice versa.

This method is pure, i.e. it does not have observable side effects.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also