Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinPhotoAcquireSettingsMBS class.
WinPhotoAcquireSettingsMBS.AcquisitionDateTime as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
This property is typically used to force two sessions to show the same acquisition time. If not explicitly set, acquisition time defaults to the current machine time.
(Read and Write property)
WinPhotoAcquireSettingsMBS.AcquisitionTime as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
This property is typically used to force two sessions to show the same acquisition time. If not explicitly set, acquisition time defaults to the current machine time.
(Read and Write property)
WinPhotoAcquireSettingsMBS.Flags as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
(Read and Write property)
WinPhotoAcquireSettingsMBS.GroupTag as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
The group tag is stored as a keyword in each file's metadata. It is also used in the file name if the $(GroupTag) token is present in the format string passed to OutputFileNameTemplate.
(Read and Write property)
WinPhotoAcquireSettingsMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
(Read only property)
WinPhotoAcquireSettingsMBS.OutputFilenameTemplate as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Format strings contain a mix of path literals and tokens. A format string looks like the following:
$(MyPicturesFolder)\$(DateAcquired), $(EventName)\$(EventName) $(SequenceNumber).$(OriginalExtension)
The token format looks like the following, where OptionalPrefix and OptionSuffix are suppressed if the replacement for the TokenIdentifier yields a zero-length string:
$([OptionalPrefix]TokenIdentifier:SubToken[OptionalSuffix]|AlternateString)
The caret ("^") is an escape character, so "^$" would yield "$" in the final path.
Parentheses and brackets are not allowed as literals within tokens, but can be used outside of tokens. This means you cannot use "[", "]", "(", or ")" within the OptionalString sub-token unless they are escaped with a caret ("^").
There are a few different classes of tokens, including the following:
SHGetSpecialFolder variables such as the following. These must be the first token, and can only occur once, at most:
- MyPicturesFolder
- MyDocumentsFolder
Session variables such as the following:
- SequenceNumber (The sequence number is used to avoid filename collisions; if it exists, it must be in the file name portion of the path.)
- DateAcquired
- EventName
- UserName
- MachineName
File and metadata variables such as the following:
- DateTaken
- OriginalFilename
- OriginalExtension
- CameraModel
- Width
- Height
Since these tokens are not intended to be visible to users, they will not be localized. For example, $(DateTaken) will be the same on all versions of Microsoft Windows, regardless of locale or language settings.
As an example, suppose EventName is "Meghan's Birthday" and the naming pattern is as follows:
$(MyPicturesFolder)\$(DateAcquired)$([, ]EventName)\$(EventName[ ])$(SequenceNumber).$(OriginalExtension)
The resulting files would be named as follows:
C:\Documents and Settings\shauniv\My Documents\My Pictures\2003-11-14, Meghan's Birthday\Meghan's Birthday 001.jpg
C:\Documents and Settings\shauniv\My Documents\My Pictures\2003-11-14, Meghan's Birthday\Meghan's Birthday 002.jpg
C:\Documents and Settings\shauniv\My Documents\My Pictures\2003-11-14, Meghan's Birthday\Meghan's Birthday 003.jpg
C:\Documents and Settings\shauniv\My Documents\My Pictures\2003-11-14, Meghan's Birthday\Meghan's Birthday 004.jpg
(Read and Write property)
WinPhotoAcquireSettingsMBS.SequencePaddingWidth as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
If the value passed to SetSequencePaddingWidth is nonzero and the format string specified in SetOutputFileNameTemplate contains a sequential token, this method sets the width allotted for the sequential token. For example, given the template $(GroupTag)$(AcquisitionSequence).$(OriginalExtension), if padding is set to 0, a file name might appear as
"Image1.jpg"
If padding is set to 3, the file name may appear as
"Image 1.jpg"
(Read and Write property)
WinPhotoAcquireSettingsMBS.SequenceZeroPadding as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows Photos | MBS WinFrameworks Plugin | 20.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop only |
Flag that, if set to true, indicates that zeros pad sequential file names.
(Read and Write property)
The items on this page are in the following plugins: MBS WinFrameworks Plugin.