• Miscellaneous Functions
  • Miscellaneous Functions
  • BROWSTAT function
  • CELLCALC function
  • CELLCOL function
  • CELLLABEL function
  • CELLNO function
  • CELLROW function
  • CELLSTR function
  • CELLTABLE function
  • CUSTPROP function
  • CUSTPROPAT Function
  • CUSTPROPR function
  • CVDATA function
  • CVDATAC function
  • CVDATAL function
  • CVDATALNG function
  • CVDATAQRY function
  • CVDOCPOS function
  • CVFORM function
  • CVGROUP function
  • CVIDEA function
  • CVINFO function
  • CVMENUST function
  • DOCID function
  • DOCMODE function
  • EVAL function
  • GETHIDE function
  • INITIALS function
  • ISCONS function
  • ISINGROUP function
  • ISINGRP function
  • KLIEXIST function
  • KLIPROP function
  • KLLPROP function
  • LEVEL function
  • LOOKUP function
  • MKPATH function
  • RDYREVIEW function
  • REPENT function
  • SCRNX function
  • SCRNY function
  • WHOAMI function

CUSTPROPAT Function

The CUSTPROPAT function returns the custom property of object item ID specified by property name. The argument scope is used to determine the searching level.

Syntax

CUSTPROPAT("item ID", "property name", "scope")

Scope can be any of the following values:

Value	Definition
C	Cell
P	Paragraph
T	Table
TR	Row
TC	Column
S	Section
D	Document Settings

The Item ID is defined by the scope:

Scope	Item ID
C	Cell Label
P	Paragraph Tag
T	Table ID
TR	Table row with the syntax table-name.row-number where row-number is 1-based row number
TC	Table column with the syntax table-name.column-number where column-number is 1-based column number
S	Section Label
D	Ignored

Note: The Item ID must be referenced directly; indirect references (i.e. through a calculation) will result in an error.

Property name represents the name of the custom property to retrieve.

Example 1

CUSTPROPAT ("T1.D2","T1B2CELL","C")

In this example the custom property "T1B2CELL" of cell "T1.D2" is retrieved.

Example 2

CUSTPROPAT ("T1","T1TABLE","T")

In this example the custom property "T1TABLE" of table "T1" is retrieved.

Example 3

CUSTPROPAT ("T1.3","T1R3ROW","TR")

In this example the custom property "T1R3ROW" of table "T1" row "3" is retrieved.