ToString(String, IFormatProvider) Method

Returns the current KeyGesture as a string formatted according to the format string and appropriate IFormatProvider

Definition

Namespace: Avalonia.Input
Assembly: Avalonia.Base (in Avalonia.Base.dll)

C#

public string ToString(
	string? format,
	IFormatProvider? formatProvider
)

VB

Public Function ToString ( 
	format As String,
	formatProvider As IFormatProvider
) As String

F#

abstract ToString : 
        format : string * 
        formatProvider : IFormatProvider -> string 
override ToString : 
        format : string * 
        formatProvider : IFormatProvider -> string 

View Source

Parameters

  String

The format to use.

null or "" or "g"The Invariant format, uses Enum.ToString() to format Keys."p"Use platform specific formatting as registerd.

  IFormatProvider

The IFormatProvider to use. If null, uses the appropriate provider registered in the Avalonia Locator, or Invariant.

Return Value

String
The formatted string.

Implements

IFormattable.ToString(String, IFormatProvider)

Exceptions

FormatException

Thrown if the format string is not null, "", "g", or "p"

See Also

Reference

KeyGesture Class
ToString Overload
Avalonia.Input Namespace