This topic has not yet been rated - Rate this topic

FormattedString Class

SharePoint 2010

Other Versions

Windows SharePoint Services 3

Renders a string formatted with .Net Composite Formatting.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    Microsoft.SharePoint.WebControls.SPControl
      Microsoft.SharePoint.WebControls.FormattedString

Namespace: Microsoft.SharePoint.WebControls
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

Copy

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class FormattedString : SPControl

Remarks

The FormatText property holds the foundational .Net composite formatted string that may contain placeholders such as "{0}" or "{1:hh}". These are replaced by actual values by the Render method.

The inherited Control() property holds the child controls whose ToString methods provide the actual values that will replace the placeholders in the FormatText property. The index order of a child control in the Control() property determines which placeholder it replaces.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

FormattedString Members

Microsoft.SharePoint.WebControls Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ