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 an Object that represents the value of the custom property specified.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Returns an {{Object}} that represents the value of the custom property specified.{excerpt}
{signature:C#}
 public System.Object GetCustomProperty(System.String key)
Signature
{signature}{signature:vb.net
vb.net
}
Public Function GetCustomProperty(ByVal key As String) As Object
Parameters

...

The name of the property to retrieve.

Returns

An Object that represents the value of the custom property specified.

Remarks

MS Word equivalent: File menu > Properties > Custom tab > Properties:

{signature}
{parameters}
{param:key}The name of the property to retrieve.{param}
{returns}An {{Object}} that represents the value of the custom property specified.{returns}
{remarks}MS Word equivalent: File menu > Properties > Custom tab > Properties:

{remarks}
{example}{code:csharp|title=C#}

          //--- Return "Priority" Custom Property
          string priority = docProps.GetCustomProperty("Priority");
        
{code}
{code:vb.net
|title=vb.net
}

          '--- Return "Priority" Custom Property
          Dim priority As String = docProps.GetCustomProperty("Priority")
        {code}

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