Class PreferencesHistory

All preferences related to history logging

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/preferences/#history

Targetfolder

classes/preferences

Min Version

24.0

Index

Accessors

createFirstSnapshot editLogItems nonLinearHistory numberOfHistoryStates saveLogItems typename useHistoryLog

Accessors

createFirstSnapshot

get createFirstSnapshot(): boolean
If true, automatically makes the first snapshot when a new document is created

Returns boolean
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:26
set createFirstSnapshot(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:27

editLogItems

get editLogItems(): EditLogItemsType
Options for edit log items.

Sets history.useHistoryLog = true as side effect.

Returns EditLogItemsType
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:56
set editLogItems(value: EditLogItemsType): void
Parameters
- value: EditLogItemsType
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:57

nonLinearHistory

get nonLinearHistory(): boolean
If true, allows non-linear history

Returns boolean
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:33
set nonLinearHistory(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:34

numberOfHistoryStates

get numberOfHistoryStates(): number
The whole number of history states to preserve [1,1000].

Returns number
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:40
set numberOfHistoryStates(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:41

saveLogItems

get saveLogItems(): SaveLogItemsType
Options for saving the history items. It can be metadata, file or both.

Sets history.useHistoryLog = true as side effect.

Returns SaveLogItemsType
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:65
set saveLogItems(value: SaveLogItemsType): void
Parameters
- value: SaveLogItemsType
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:66

typename

get typename(): "PreferencesHistory"
The class name of the referenced object: "PreferencesHistory".

Returns "PreferencesHistory"
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:20

useHistoryLog

get useHistoryLog(): boolean
Turn on and off the history logging

Returns boolean
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:47
set useHistoryLog(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts:48

Class PreferencesHistory

See

Targetfolder

Min Version

Index

Accessors

Accessors

createFirstSnapshot

Returns boolean

Min Version

Parameters

Returns void

editLogItems

Returns EditLogItemsType

Min Version

Parameters

Returns void

nonLinearHistory

Returns boolean

Min Version

Parameters

Returns void

numberOfHistoryStates

Returns number

Min Version

Parameters

Returns void

saveLogItems

Returns SaveLogItemsType

Min Version

Parameters

Returns void

typename

Returns "PreferencesHistory"

Min Version

useHistoryLog

Returns boolean

Min Version

Parameters

Returns void

Settings

On This Page