Page tree

Versions Compared

Key

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

Excerpt

Returns the document variable specified by name.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Returns the document variable specified by name.{excerpt}
{signature:C#}
 public System.String GetVariable(System.String name)
Signature
{signature}{signature:vb.net
vb.net
}
Public Function GetVariable(ByVal name As String) As String
Parameters

...

The name of the variable.

Returns

The document variable specified by name. If the variable does not exist, GetVariable returns null.

{signature}
{parameters}
{param:name}The name of the variable.{param}
{returns}The document variable specified by name.  If the variable does not exist, [GetVariable|Document.GetVariable(String)] returns null.{returns}
{example}{code:csharp|title=C#}
string docVariable = doc.GetVariable("var");
{code}
{code:vb.net
|title=vb.net
}
Dim docVariable As String = doc.GetVariable("var"){code}

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