Skip to content

documentinfo

Metadata about a document object.

These values can be set by selecting File > File Info in the Adobe Photoshop application.

DocumentInfo

Bases: Photoshop

Metadata about a document object.

Source code in photoshop/api/_documentinfo.py
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
class DocumentInfo(Photoshop):
    """Metadata about a document object."""

    def __init__(self, parent):
        super().__init__(parent=parent)

    def __str__(self):
        return pformat(
            {
                "author": self.author,
                "authorPosition": self.authorPosition,
                "caption": self.caption,
                "captionWriter": self.captionWriter,
                "category": self.category,
                "city": self.city,
                "country": self.country,
                "copyrightNotice": self.copyrightNotice,
                "copyrighted": self.copyrighted,
                "creationDate": self.creationDate,
                "credit": self.credit,
                "exif": self.exif,
                "headline": self.headline,
                "instructions": self.instructions,
                "jobName": self.jobName,
                "keywords": self.keywords,
                "provinceState": self.provinceState,
                "source": self.source,
                "ownerUrl": self.ownerUrl,
                "supplementalCategories": self.supplementalCategories,
                "title": self.title,
                "transmissionReference": self.transmissionReference,
                "urgency": self.urgency,
            }
        )

    @property
    def author(self):
        """str: The author."""
        return self.app.author

    @author.setter
    def author(self, name):
        self.app.author = name

    @property
    def authorPosition(self):
        """str:The author’s position."""
        return self.app.authorPosition

    @authorPosition.setter
    def authorPosition(self, name):
        self.app.authorPosition = name

    @property
    def caption(self):
        return self.app.caption

    @caption.setter
    def caption(self, name):
        self.app.caption = name

    @property
    def captionWriter(self):
        return self.app.captionWriter

    @captionWriter.setter
    def captionWriter(self, name):
        self.app.captionWriter = name

    @property
    def category(self):
        """str: The document category."""
        return self.app.category

    @category.setter
    def category(self, name):
        self.app.category = name

    @property
    def city(self):
        return self.app.city

    @city.setter
    def city(self, city_name):
        self.app.city = city_name

    @property
    def copyrightNotice(self):
        """str: The copyright notice."""
        return self.app.copyrightNotice

    @copyrightNotice.setter
    def copyrightNotice(self, name):
        self.app.copyrightNotice = name

    @property
    def copyrighted(self):
        """str: The copyright status."""
        return self.app.copyrighted

    @copyrighted.setter
    def copyrighted(self, info):
        self.app.copyrighted = info

    @property
    def country(self):
        return self.app.country

    @country.setter
    def country(self, name):
        self.app.country = name

    @property
    def creationDate(self):
        return self.app.creationDate

    @creationDate.setter
    def creationDate(self, name):
        self.app.creationDate = name

    @property
    def credit(self):
        """str: The author credit."""
        return self.app.credit

    @credit.setter
    def credit(self, value):
        self.app.credit = value

    @property
    def exif(self):
        return self.app.exif

    @exif.setter
    def exif(self, info):
        self.app.exif = info

    @property
    def headline(self):
        return self.app.headline

    @headline.setter
    def headline(self, value):
        self.app.headline = value

    @property
    def instructions(self):
        return self.app.instructions

    @instructions.setter
    def instructions(self, value):
        self.app.instructions = value

    @property
    def jobName(self):
        return self.app.jobName

    @jobName.setter
    def jobName(self, job):
        self.app.jobName = job

    @property
    def keywords(self):
        return self.app.keywords

    @keywords.setter
    def keywords(self, words):
        self.app.keywords = words

    @property
    def ownerUrl(self):
        return self.app.ownerUrl

    @ownerUrl.setter
    def ownerUrl(self, url):
        self.app.ownerUrl = url

    @property
    def provinceState(self):
        """str: The state or province."""
        return self.app.provinceState

    @provinceState.setter
    def provinceState(self, state_name):
        self.app.provinceState = state_name

    @property
    def source(self):
        return self.app.source

    @source.setter
    def source(self, source_name):
        self.app.source = source_name

    @property
    def supplementalCategories(self):
        """str: Other categories."""
        return self.app.supplementalCategories

    @supplementalCategories.setter
    def supplementalCategories(self, info):
        self.app.supplementalCategories = info

    @property
    def title(self):
        return self.app.title

    @title.setter
    def title(self, name):
        self.app.title = name

    @property
    def transmissionReference(self):
        """str: The transmission reference."""
        return self.app.transmissionReference

    @transmissionReference.setter
    def transmissionReference(self, reference):
        self.app.transmissionReference = reference

    @property
    def urgency(self):
        """The document urgency."""
        return self.app.urgency

    @urgency.setter
    def urgency(self, status):
        self.app.urgency = status

author property writable

authorPosition property writable

category property writable

copyrightNotice property writable

copyrighted property writable

credit property writable

provinceState property writable

supplementalCategories property writable

transmissionReference property writable

urgency property writable

The document urgency.


Last update: 2024-11-17
Created: 2024-11-17