This is the official manual for the latest Org-mode release.
Here is a description of the functions that can be used to work with properties.
Get all properties of the entry at point-or-marker POM.
This includes the TODO keyword, the tags, time strings for deadline, scheduled, and clocking, and any additional properties defined in the entry. The return value is an alist. Keys may occur multiple times if the property key was used several times.
POM may also benil
, in which case the current entry is used. If WHICH isnil
or `all', get all properties. If WHICH is `special' or `standard', only get that subclass.
Get value of
PROPERTY
for entry at point-or-markerPOM
. By default, this only looks at properties defined locally in the entry. IfINHERIT
is non-nil
and the entry does not have the property, then also check higher levels of the hierarchy. IfINHERIT
is the symbolselective
, use inheritance if and only if the setting oforg-use-property-inheritance
selectsPROPERTY
for inheritance.
Delete the property
PROPERTY
from entry at point-or-marker POM.
Set
PROPERTY
toVALUE
for entry at point-or-marker POM.
Get all property keys in the current buffer.
Set
PROPERTY
at point-or-markerPOM
toVALUES
.VALUES
should be a list of strings. They will be concatenated, with spaces as separators.
Treat the value of the property
PROPERTY
as a whitespace-separated list of values and return the values as a list of strings.
Treat the value of the property
PROPERTY
as a whitespace-separated list of values and make sure thatVALUE
is in this list.
Treat the value of the property
PROPERTY
as a whitespace-separated list of values and make sure thatVALUE
is not in this list.
Treat the value of the property
PROPERTY
as a whitespace-separated list of values and check ifVALUE
is in this list.
Hook for functions supplying allowed values for a specific property. The functions must take a single argument, the name of the property, and return a flat list of allowed values. If ‘:ETC’ is one of the values, use the values as completion help, but allow also other values to be entered. The functions must return
nil
if they are not responsible for this property.