Platforms to show: All Mac Windows Linux Cross-Platform

FolderItem class

• 14 properties
  • property AccessDateMBS(UTC as boolean = false) as date
  • property AccessDateTimeMBS(UTC as boolean = false) 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 AddedToDirectoryDateMBS as date
  • method AddedToDirectoryDateTimeMBS as DateTime
  • 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 string) 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 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

Some useful global functions for this class:

• CGNewPDFDocumentMBS(file as folderitem, MediaBox as CGRectMBS, title as string, author as string, creator as string) as CGPDFContextMBS
• CreateBundleMBS(file as folderitem) as CFBundleMBS
• GetWindowsDisplayColorProfileMBS(DisplayName as String) as folderitem
• LaunchServicesApplicationForItemMBS(file as folderitem, role as Integer) as folderitem
• NewCIImagewithFileMBS(file as folderitem) as CIImageMBS
• NewCIImagewithFileMBS(file as folderitem, cgcolorspace as CGColorSpaceMBS) as CIImageMBS
• NewFolderItemFromAbsolutePathMBS(AbsolutePath as string) as FolderItem
• NewVolumeFolderItemMBS(vRefNum as Integer) as FolderItem
• PathToFolderItemMBS(path as string) as folderitem
• WinOpenFolderAndSelectItemsMBS(folder as folderitem, files() as folderItem, ShowOnDesktop as Boolean = false, EditName as Boolean = false) as Integer

Some methods using this class:

• CDDrawAreaMBS.patternColor(file as folderitem, startX as Integer = 0, startY as Integer = 0) as Integer
• CKAssetMBS.Constructor(file as FolderItem)
• DynaPDFMBS.ConvertEMFSpool(File as folderitem, LeftMargin as Double, TopMargin as Double, Flags as Integer = 0) as Integer
• DynaPDFMBS.InsertImageEx(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, File as folderitem, index as Integer = 1) as Integer
• GMImageMBS.ping(file as folderitem)
• GrowlApplicationBridgeMBS.LoadFramework(path as folderitem) as boolean
• NSFileManagerMBS.linkItem(source as folderItem, dest as folderItem, byref error as NSErrorMBS) as boolean
• NSFileWrapperMBS.readFromFile(File as FolderItem, Options as Integer = 0, byref Error as NSErrorMBS) as Boolean
• PackbitsMBS.Compress(InputFile as FolderItem, OutputFile as FolderItem) as boolean
• SQLParamMBS.ReadLongOrLob(toFile as FolderItem)

Some properties using for this class:

• CURLNMimePartMBS.File as FolderItem
• DynaPDFColorProfilesMBS.SoftProof as FolderItem
• FileListMBS.Folder as FolderItem
• FileMappingMBS.File as FolderItem
• MLMediaObjectMBS.File as FolderItem
• NSSavePanelMBS.Directory as folderitem
• OpenDialogMBS.File as FolderItem
• PNGOptimizerMBS.InputFile as FolderItem
• PNGReaderMBS.SourceFile as FolderItem
• Window.WindowProxyIconFileMBS 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)
• ImageCaptureEventsMBS.scannerDeviceDidScanToURL(scanner as ICScannerDeviceMBS, URL as string, file as folderitem, data as MemoryBlock)
• NSFileCoordinatorMBS.coordinateReadingItemAtURL(url as string, file as folderitem, tag as Variant)
• NSOutlineControlMBS.namesOfPromisedFilesDroppedAtDestination(dropDestination as folderItem, DraggedItems() as NSOutlineViewItemMBS) as string()
• NSSavePanelMBS.shouldShowFilename(path as string, item as folderitem) as boolean
• NSTableControlMBS.namesOfPromisedFilesDroppedAtDestination(dropDestination as folderItem, DraggedRowsWithIndexes as NSIndexSetMBS) as string()
• NSURLDownloadMBS.didCreateDestination(path as string, file as folderitem)
• NSURLSessionMBS.downloadTaskDidFinishDownloadingToURL(downloadTask as NSURLSessionDownloadTaskMBS, location as String, file as FolderItem)
• OpenDialogMBS.FilterItem(file as folderitem, filterMode as Integer) as boolean
• QLPreviewPanelMBS.willLoadPreviewItem(file as folderitem)

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