Platforms to show: All Mac Windows Linux Cross-Platform

FolderItem class

• 16 properties
  • property AccessDateMBS(UTC as boolean = false) as date
  • property AccessDateTimeMBS(UTC as boolean = false) as DateTime
  • property AddedToDirectoryDateMBS as date
  • property AddedToDirectoryDateTimeMBS as DateTime
  • property AttributeModificationDateMBS(UTC as boolean = false) as date
  • property AttributeModificationDateTimeMBS(UTC as boolean = false) as DateTime
  • property BackupDateMBS(UTC as boolean = false) as date
  • property BackupDateTimeMBS(UTC as boolean = false) as DateTime
  • property BackupItemExcludedMBS as boolean
  • property CommentMBS as string
  • property CreationDateMBS(UTC as boolean = false) as date
  • property CreationDateTimeMBS(UTC as boolean = false) as DateTime
  • property FinderLabelMBS as Integer
  • property MacQuarantinePropertiesMBS as MacQuarantinePropertiesMBS
  • property ModificationDateMBS(UTC as boolean = false) as date
  • property ModificationDateTimeMBS(UTC as boolean = false) as DateTime
• 138 methods
  • method AbsolutePath as string
  • method AbsolutePathMBS as string
  • method BackupIsItemExcludedMBS(byref excludeByPath as boolean) as boolean
  • method BackupSetItemExcludedMBS(exclude as boolean, excludeByPath as boolean) as Integer
  • method CalculateDirectorySizeMBS(recursive as boolean = false, ticks as Integer = 0, QueryCompressedSizes as boolean = false, RecursionLimit as Integer = -1) as DirectorySizeMBS
  • method CompressedFileLengthMBS as int64
  • method CreateLargeBinaryStreamMBS(MacType as string, MacCreator as string) as LargeBinaryStreamMBS
  • method CreateResStreamMBS(MacType as string, MacCreator as string) as ResStreamMBS
  • method CreatorAppMBS as FolderItem
  • method CreatorAppMBS(creatorCode as String) as FolderItem
  • method DarwinMediaClassMBS as string
  • method DarwinMediaInfoMBS as CFDictionaryMBS
  • method DarwinVolumeNameMBS as string
  • method DeleteDataForkMBS
  • method DeleteResourceForkMBS
  • method DisplayPathMBS(delimiter as string = "/") as string
  • method EjectVolumeMBS(force as boolean, byref dissenterPID as Integer) as Integer
  • method FilesMBS as FolderItem()
  • method FlushVolumeMBS as Integer
  • method FoldersMBS as FolderItem()
  • method FontActivateMBS(OnlyLocal as boolean) as Integer
  • method FontDeactivateMBS(OnlyLocal as boolean) as Integer
  • method GetFileFlagsMBS as Integer
  • method GetFolderFlagsMBS as Integer
  • method GetVolumeRefMBS as Integer
  • method HasUnresolvedConflictsMBS as boolean
  • method IconImageMBS(width as Integer, WindowsFlags as Integer=0) as picture
  • method IconMaskMBS(width as Integer, WindowsFlags as Integer=0) as picture
  • method IconMBS(width as Integer, WindowsFlags as Integer=0) as picture
  • method isApplicationMBS as boolean
  • method isBundleMBS as boolean
  • method IsCompressedFileMBS as Boolean
  • method IsDownloadedMBS as boolean
  • method IsDownloadingMBS as boolean
  • method IsEjectableVolumeMBS as Boolean
  • method IsEncryptedFileMBS as Boolean
  • method IsFileDataForkOpenReadWriteMBS as boolean
  • method IsFileResourceForkOpenReadWriteMBS as boolean
  • method IsOnRemoteVolumeMBS as Boolean
  • method IsUbiquitousItemMBS as boolean
  • method IsUploadedMBS as boolean
  • method IsUploadingMBS as boolean
  • method ItemsMBS as FolderItem()
  • method KindMBS as string
  • method LaunchMBS(inFront as Boolean) as Boolean
  • method LaunchServicesApplicationForItemMBS(role as Integer) as folderitem
  • method LaunchServicesApplicationsForItemMBS(role as Integer) as LaunchServicesApplicationListMBS
  • method LaunchServicesCanApplicationAcceptItemMBS(TargetApp as folderitem, role as Integer, flags as Integer) as boolean
  • method LaunchServicesDisplayNameMBS as string
  • method LaunchServicesItemInfoMBS(WhichInfo as Integer) as LaunchServicesItemInfoMBS
  • method LaunchServicesKindStringMBS as string
  • method LaunchServicesOpenMBS as folderitem
  • method LaunchServicesRegisterMBS(update as boolean) as Integer
  • method LogicalFileDataLengthMBS as int64
  • method LogicalFileResLengthMBS as int64
  • method LogicalFileTotalLengthMBS as int64
  • method LongPathMBS as string
  • method MacCopyObjectMBS(DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
  • method MacIsHardLinkedMBS as boolean
  • method MacMoveObjectMBS(DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
  • method MacMoveObjectToTrashMBS(byref Result as folderitem, Options as Integer) as Integer
  • method MacNodeIDMBS as UInt64
  • method MacParentDirectoryIDMBS as UInt64
  • method MacResolveNodeIDMBS(NodeID as UInt64) as folderitem
  • method NameExtensionMBS as string
  • method NameWithoutExtensionMBS as string
  • method NativePath as string
  • method NewCGPDFDocumentMBS(MediaBox as CGRectMBS, title as string, author as string, creator as string) as CGPDFContextMBS
  • method NewCGPDFDocumentMBS(MediaBox as CGRectMBS, title as string, author as string, creator as string, subject as string, keywords as string, OwnerPassword as string, UserPassword as string, AllowsPrinting as boolean, AllowsCopy as boolean) as CGPDFContextMBS
  • method NewCGPDFDocumentMBS(MediaBox as CGRectMBS, title as string, author as string, creator as string, subject as string, keywords as string, OwnerPassword as string, UserPassword as string, AllowsPrinting as boolean, AllowsCopy as boolean, KeyLength as Integer) as CGPDFContextMBS
  • method NewCGPDFDocumentWithInfoMBS(MediaBox as CGRectMBS, info as object) as CGPDFContextMBS
  • method OpenAsCGPDFDocumentMBS as CGPDFDocumentMBS
  • method OpenAsGIFMBS as GIFMBS
  • method OpenAsJPEGMBS as picture
  • method OpenAsJPEGMBS(allowdamaged as Boolean) as picture
  • method OpenAsJPEGMBS(allowdamaged as Boolean,fileposition as Integer) as picture
  • method OpenAsLargeBinaryStreamMBS(write as Boolean) as LargeBinaryStreamMBS
  • method OpenAsPNGMBS(gamma as single = 0.0, AllowDamaged as Boolean = false) as PNGPictureMBS
  • method OpenAsResStreamMBS(write as Boolean) as ResStreamMBS
  • method OpenAsTiffMBS(HeaderOnly as boolean=false) as TiffPictureMBS
  • method OpenWithAppMBS(TheApplication as FolderItem, inFront as Boolean) as Boolean
  • method ParentVolumeMBS as folderitem
  • method PercentDownloadedMBS as Double
  • method PercentUploadedMBS as Double
  • method PermissionsMBS(OldWay as boolean) as PermissionsMBS
  • method PhysicalFileDataLengthMBS as int64
  • method PhysicalFileResLengthMBS as int64
  • method PhysicalFileTotalLengthMBS as int64
  • method QuickLookMBS(MaxWidth as Integer = 500, MaxHeight as Integer = 500, IconMode as Boolean = false, ScaleFactor as Double = 1.0) as picture
  • method QuickLookMTMBS(MaxWidth as Integer = 500, MaxHeight as Integer = 500, IconMode as Boolean = false, ScaleFactor as Double = 1.0) as picture
  • method ReadFileMBS(byref data as MemoryBlock, offset As Integer = 0, byteCount As Integer = -1) as boolean
  • method ReadFileMBS(byref data as string, offset As Integer = 0, byteCount As Integer = -1) as boolean
  • method SaveAs8BitAlphaPNGMBS(pic as picture, colors() as color, alphas() as Integer, gamma as single = 0.0) as boolean
  • method SaveAs8BitAlphaPNGMBS(pic as picture, colors() as color, alphas() as Integer, gamma as single, Interlace as Boolean, FilterType as Integer) as boolean
  • method SaveAs8BitPNGMBS(pic as picture, colors() as color, gamma as single = 0.0) as boolean
  • method SaveAs8BitPNGMBS(pic as picture, colors() as color, gamma as single, Interlace as Boolean, FilterType as Integer) as boolean
  • method SaveAsGIFMBS(data as GIFMBS) as boolean
  • method SaveAsJPEGMBS(pic as picture, quality as Integer = 80) as boolean
  • method SaveAsPNGMBS(pic as picture, gamma as single = 0.0) as boolean
  • method SaveAsPNGMBS(pic as picture, gamma as single, Interlace as Boolean, FilterType as Integer) as boolean
  • method SaveAsPNGMBS(pic as picture, mask as picture, gamma as single = 0.0) as boolean
  • method SaveAsPNGMBS(pic as picture, mask as picture, gamma as single, Interlace as Boolean, FilterType as Integer) as boolean
  • method SetDesktopPictureMBS as Integer
  • method SetFileFlagsMBS(flags as Integer) as Integer
  • method SetFolderFlagsMBS(flags as Integer) as Integer
  • method SetTagNamesMBS(tags() as string) as Integer
  • method SetTagNamesMBS(tags() as string, byref e as CFErrorMBS) as Integer
  • method ShortPathMBS as string
  • method SortedFilesMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
  • method SortedFoldersMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
  • method SortedItemsMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
  • method SpotLightFileInfoMBS(uti as string = "") as dictionary
  • method SpotLightLoadMDImporterMBS as boolean
  • method SpotLightTextContentMBS(uti as string = "") as string
  • method TagNamesMBS as string()
  • method TagNamesMBS(byref e as CFErrorMBS) as string()
  • method TrueFilesMBS as FolderItem()
  • method TrueFoldersMBS as FolderItem()
  • method TrueItemsMBS as FolderItem()
  • method UnixpathMBS as string
  • method UnMountVolumeMBS(force as boolean = false) as Integer
  • method UnMountVolumeMBS(force as boolean, byref dissenterPID as Integer) as Integer
  • method USBSerialNumberMBS as string
  • method VolGetFolderItemIDMBS(createFileIDs as Boolean = true) as Integer
  • method VolSupportsCatSearchMBS as Boolean
  • method VolumeFreeSizeMBS as Int64
  • method VolumeInformationMBS as VolumeInformationMBS
  • method VolumeSizeMBS as Int64
  • method VolumeSupportsHugeFilesMBS as Integer
  • method VolumeUUIDMBS as string
  • method WinThumbnailMBS(preferredSize as Integer = 512) as picture
  • method WriteFileMBS(data as MemoryBlock) as boolean
  • method WriteFileMBS(data as string) as boolean

This class has no sub classes.

See also in the Xojo Language Reference

Release notes

• Version 25.5
  • Added USBSerialNumberMBS function for FolderItem class.
• Version 25.1
  • Improved TrueItemsMBS function to be quicker.
• Version 24.3
  • Improved JSONMBS class conversion from variant to convert folderitem to native path, Date & DateTime to SQLDateTime or from JSONItem objects.
• Version 23.5
  • Fixed FolderItem.PhysicalFileTotalLengthMBS function for Windows to report block size.
• Version 23.4
  • Added fallback for FontActivateMBS to use AddFontResourceW if AddFontResourceExW fails.
  • Fixed crash in XMLDocumentMBS constructor when passing folderitem pointing to a folder.
  • Fixed ReadFileMBS function when passing an offset.
• Version 23.1
  • Added Offset and Length parameters for FolderItem.ReadFileMBS function.
• Version 22.5
  • Changed AddedToDirectoryDateMBS and AddedToDirectoryDateTimeMBS in FolderItem class to be settable.
  • Fixed potential issue in VolumeSizeMBS function when NULL value is returned from system.
• Version 22.0
  • Fixed a bug where some functions like GetWindowsColorProfileMBS returning a FolderItem cause an InvalidArgumentException when running on newer Xojo versions.
• Version 21.5
  • Fixed code to return FolderItem in various functions on iOS.

Some useful global functions for this class:

• CGNewPDFDocumentMBS(file as folderitem, MediaBox as CGRectMBS, title as string, author as string, creator as string, subject as string, keywords as string, OwnerPassword as string, UserPassword as string, AllowsPrinting as boolean, AllowsCopy as boolean, KeyLength as Integer) as CGPDFContextMBS
• CombineBitCMYKtoCMYKMBS(dest as TiffPictureMBS, CyanChannel() as Integer, MagentaChannel() as Integer, YellowChannel() as Integer, BlackChannel() as Integer, Files() as FolderItem, scale as Double, width as Integer, height as Integer, X1 as Integer, Y1 as Integer, X2 as Integer, Y2 as Integer, CacheSizeRead as Integer) as Integer
• CombineBitCMYKtoRGBMBS(CyanChannel() as Integer, MagentaChannel() as Integer, YellowChannel() as Integer, BlackChannel() as Integer, Files() as FolderItem, scale as Double, width as Integer, height as Integer, X1 as Integer, Y1 as Integer, X2 as Integer, Y2 as Integer, byref output as picture, CacheSizeRead as Integer) as Integer
• FolderItemToPathMBS(file as folderitem) as string
• GetWindowsColorProfileMBS as folderitem
• GetWindowsDisplayColorProfileMBS(DisplayIndex as Integer) as folderitem
• LaunchServicesFindApplicationForInfoMBS(creator as string, bundleID as string, name as string) as folderitem
• NewCFURLMBSFile(f as folderitem) as CFURLMBS
• Split1BitFileMBS(f as folderitem, fc as folderitem, fm as folderitem, fy as folderitem, fk as folderitem, width as Integer, height as Integer, CallbackTarget as object, CacheSizeRead as Integer, CacheSizeWrite as Integer) as Integer
• VolResolveIDMBS(volume as FolderItem, id as Integer) as FolderItem

Some methods using this class:

• CGImageSourceMBS.CreateWithFile(file as folderitem, options as dictionary=nil) as CGImageSourceMBS
• CSProfileMBS.File(byref error as CFErrorMBS) as folderitem
• ImageCaptureObjectMBS.DownloadFile(dir as folderitem, flags as Integer, MacType as string, MacCreator as string, angle as Double) as folderitem
• NSAttributedStringMBS.attributedStringWithPath(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• NSFileManagerMBS.setAttributes(attributesDic as dictionary, item as folderitem, byref error as NSErrorMBS) as boolean
• NSFileManagerMBS.setUbiquitous(flag as boolean, item as folderitem, destitem as folderitem, byref error as NSErrorMBS) as boolean
• NSMetadataItemMBS.File as folderitem
• OSAScriptMBS.Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS)
• PhidgetManagerMBS.LoadLibrary(file as FolderItem) as Boolean
• SQLParamMBS.ReadLongOrLob(toFile as FolderItem)

Some properties using for this class:

• CatSearchMBS.Result as folderitem
• CTFontDescriptorMBS.File as FolderItem
• DynaPDFColorProfilesMBS.DeviceProfile as FolderItem
• IKSlideshowMBS.AudioFile as FolderItem
• ImagePlaygroundMBS.ImageFile as FolderItem
• iTunesLibraryMediaItemMBS.locationFile as FolderItem
• JPEGTransformationMBS.InputFile as FolderItem
• LaunchServicesLaunchParameterMBS.Application as FolderItem
• MacFileOperationStatusMBS.CurrentItem as FolderItem
• RegistryFileTypeMBS.AppFile as FolderItem

Some events using this class:

• AVFoundationMBS.WriteCGImageToFileCompleted(file as folderitem, type as string, image as Variant, options as dictionary, success as boolean, tag as Variant)
• DesktopIKScannerDeviceViewControlMBS.DidScanToURL(url as String, file as FolderItem, fileData as MemoryBlock, error as NSErrorMBS)
• IKCameraDeviceViewMBS.DidDownloadFile(CameraFile as ICCameraFileMBS, URL as string, File as folderItem, data as MemoryBlock, error as NSErrorMBS)
• ImageCaptureEventsMBS.scannerDeviceDidScanToURL(scanner as ICScannerDeviceMBS, URL as string, file as folderitem, data as MemoryBlock)
• ImageCaptureEventsMBS.scannerDeviceViewDidScanToURL(scannerDeviceView as IKScannerDeviceViewMBS, url as String, file as FolderItem, fileData as MemoryBlock, error as NSErrorMBS)
• NSFileCoordinatorMBS.coordinateReadingItemAtURLwritingItemAtURL(readingURL as string, readingFile as folderitem, writingURL as string, writingFile as folderitem, tag as Variant)
• NSSavePanelMBS.shouldShowFilename(path as string, item as folderitem) as boolean
• NSWorkspaceMBS.duplicateCompleted(files() as FolderItem, Mapping as Dictionary, error as NSErrorMBS, tag as Variant)
• OpenDialogMBS.SelectionChanged(file as folderitem)
• QLPreviewControllerMBS.editingModeForPreviewItem(Item as FolderItem) as Integer

Some related classes:

• class AVFoundationMBS
• class GIFMBS
• class ICCameraFileMBS
• class ImageCaptureEventsMBS
• class ImagePlaygroundMBS
• class NSAttributedStringMBS
• class NSFileManagerMBS
• class NSSavePanelMBS
• class PhidgetManagerMBS
• class PNGpictureMBS

The items on this page are in the following plugins: MBS Images Plugin, MBS MacCF Plugin, MBS MacCG Plugin, MBS MacClassic Plugin, MBS MacCloud Plugin, MBS MacFrameworks Plugin, MBS MacOSX Plugin, MBS Picture Plugin, MBS Util Plugin, MBS Win Plugin.

FolderChangedNotificationMBS   -   FSEventsMBS