Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

Creates and returns a MergeField at the beginning of this Element. This merge field will have the specified name and contents.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Creates and returns a [MergeField|MergeField] at the beginning of this Element. This merge field will have the specified name and contents.{excerpt}
{signature:C#}
 public virtual MergeField InsertMergeFieldBefore(System.String fieldName, System.String display)
Signature
{signature}{signature:vb.net
vb.net
}
Public Overridable Function InsertMergeFieldBefore(ByVal fieldName As String, ByVal display As String) As MergeField
Parameters

...

A String representing the name of this merge field.

...

A String representing the text that will displayed for this merge field in the document.

Returns

A MergeField object representing the newly created merge field.

Exceptions
{signature}
{parameters}
{param:fieldName}A {{String}} representing the name of this merge field.{param}
{param:display}A {{String}} representing the text that will displayed for this merge field in the document.{param}
{returns}A {{MergeField}} object representing the newly created merge field.{returns}
{exceptions}
{exception:System.Exception}{exception}
{example}{code:csharp|title=C#}
MergeField mfield = e.InsertMergeFieldBefore("MyField", "ThisNameIsDisplayed");
{code}
{code:vb.net
|title=vb.net
}
Dim mfield As MergeField = e.InsertMergeFieldBefore("MyField", "ThisNameIsDisplayed"){code}

{example}
Exception
System.ExceptionSystem.Exception
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle