Click or drag to resize

StringExtensionsCenterText(String, Int32, Char) Method

Centers text within the specified maximum length, biased to the left. Text will be padded to the left and right with specified padding character. If value is greater than specified maximum length, value returned will be truncated from the right.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public static string CenterText(
	this string value,
	int maxLength,
	char paddingCharacter
)
View Source

Parameters

value  String
A String to be centered.
maxLength  Int32
An Int32 that is the maximum length of padding.
paddingCharacter  Char
The Char value to pad with.

Return Value

String
The centered string value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
Handles multiple lines of text separated by Environment.NewLine.
See Also