DashboardHelperFormatDashboardContentString Method |
In a fashion similar to String.Format() this takes a formatted string with
positional placeholders, and replaces them with content generated from the
IDashboardContent item at the corresponding position.
Namespace:
MFiles.VAF.Configuration.Domain.Dashboards
Assembly:
MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 21.8.10524.1
Syntaxpublic static XmlDocumentFragment FormatDashboardContentString(
XmlDocument xml,
string format,
params IDashboardContent[] contentItems
)
Public Shared Function FormatDashboardContentString (
xml As XmlDocument,
format As String,
ParamArray contentItems As IDashboardContent()
) As XmlDocumentFragment
public:
static XmlDocumentFragment^ FormatDashboardContentString(
XmlDocument^ xml,
String^ format,
... array<IDashboardContent^>^ contentItems
)
Parameters
- xml
- Type: System.XmlXmlDocument
The xml document to which the resutling fragment will be added. - format
- Type: SystemString
The format string. - contentItems
- Type: MFiles.VAF.Configuration.Domain.DashboardsIDashboardContent
The items whose content will replace the format string's placeholders
Return Value
Type:
XmlDocumentFragment
Remarks
This is useful for injecting markup inside text. For instance, a sentence,
where one word should be a link.
See Also