Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

NSImageMBS.accessibilityDescription as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 12.2 Yes No No Yes, macOS only No
Function: The image's accessibility description.
Notes:
A short localized string that does not include the name of the interface element.

This description will be used automatically by interface elements that display images. Like all accessibility descriptions, the string should be a short localized string that does not include the name of the interface element. For instance, "delete" rather than "delete button".
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.backgroundColor as NSColorMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 8.4 Yes No No Yes, macOS only No
Function: The background color of image.
Notes:
The background color of the image. The default color is transparent, as returned by the clearColor method of NSColor.
The background color is visible only if the drawn image representation does not completely cover all of the pixels available for the image's current size.

The value of this variant must be an object of class NSColorMBS.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.cacheDepthMatchesImageDepth as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether an image's offscreen window caches use the same bit depth as the image data itself.
Notes:
Returns true if the offscreen window caches use the same bit depth as the image data; otherwise, false. The default value is false.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.cacheMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: The receiver's caching mode.
Notes:
The caching mode determines when the receiver's image representations use offscreen caches. Offscreen caches speed up rendering time but do so by using extra memory. In the default caching mode (NSImageCacheDefault), each image representation chooses the caching technique that produces the fastest drawing times. For example, in the default mode, the NSPDFImageRep and NSEPSImageRep classes use the NSImageCacheAlways mode but the NSBitmapImageRep class uses the NSImageCacheBySize mode.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.EXIFData as Dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 12.0 Yes No No Yes, macOS only No
Function: Returns a dictionary with exif data.
Notes: (Read only property)

Feedback, Comments & Corrections

NSImageMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: The handle to the internally used NSImage object.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.height as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: The height of the image or zero.
Notes:
If no size has been set and the size cannot be determined from any of the receiver's image representations.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.isCachedSeparately as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether each image representation caches its contents in a separate offscreen window.
Notes:
Returns true if the image representations cache their content in separate offscreen windows; otherwise, false. The default value is false.

Discussion:
If this method returns false, it means that the image may be cached in a shared window but is not required to be. Images are cached in a shared window if they have the same general attributes, such as color space, resolution, and bit depth.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.isDataRetained as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether the receiver retains its source image data.
Notes:
Returns true if the image retains its source data; otherwise, false. The default value is false with some exceptions, which are covered in the discussion.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.isFlipped as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether the image uses a flipped coordinate system.
Notes:
Returns true if the image's coordinate system is flipped; otherwise, false. The default is false.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.isTemplate as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: A Boolean value indicating whether the image is a template image.
Notes:
Value is true if the image is a template image; otherwise, false.
Template images consist of black and clear colors (and an alpha channel). Template images are not intended to be used as standalone images and are usually mixed with other content to create the desired final appearance.
Available in Mac OS X v10.5 and later.
Assigning value to istemplate, will internally call setTemplate.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.isValid as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether the image can be drawn.
Notes:
Return value: true if the receiver can be drawn; otherwise, false.

If the object is initialized with an existing image file, but the corresponding image data is not yet loaded into memory, this method loads the data and expands it as needed. If the object contains no image representations and no associated image file, this method creates a valid cached image representation and initializes it to the default bit depth. This method returns false in cases where the file or URL from which it was initialized is nonexistent or when the data in an existing file is invalid.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.matchesOnMultipleResolution as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether image representations whose resolution is an integral multiple of the device resolution are considered a match.
Notes:
Returns true if image representations whose resolution is an integral multiple of the device resolution are considered a match; otherwise, false.

Discussion:
When this method returns false, only image representations whose resolution is exactly the same as the device resolution are considered matches. If this method returns true and multiple image representations fit this criteria, the one whose resolution is closest to the device resolution is chosen.

The default value is true.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.MaximumPixelHeight as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: From all the image representation the height of the heighest one.
Notes:
Value is returned in pixels. Returns 0 on any error.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.MaximumPixelWidth as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: From all the image representation the width of the widest one.
Notes:
Value is returned in pixels. Returns 0 on any error.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.MinimumPixelHeight as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: From all the image representation the width of the smallest one.
Notes:
Value is returned in pixels. Returns 0 on any error.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.MinimumPixelWidth as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: From all the image representation the width of the smallest one.
Notes:
Value is returned in pixels. Returns 0 on any error.
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.name as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns the name associated with the receiver, if any.
Notes: (Read only property)

Feedback, Comments & Corrections

NSImageMBS.prefersColorMatch as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether the image prefers to choose image representations using color matching or resolution matching.
Notes:
Discussion:
Both color matching and resolution matching may influence the choice of an image representation. This method simply indicates which technique is used first during the selection process. The default value is true.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.RepresentationsCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Number of represtations this image has.
Notes:
Same as Representations.Count
(Read only property)

Feedback, Comments & Corrections

NSImageMBS.scalesWhenResized as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Returns a Boolean value indicating whether image representations are scaled to fit the receiver's size.
Notes:
Returns true if image representations are scaled to fit the receiver; otherwise, false. The default value is false.

Images are not resized during drawing if this method returns true. They are only resized when you change the size by sending the receiver a setSize message.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.size as NSSizeMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: The size of the receiver.
Notes:
The size of the receiver or (0.0, 0.0) if no size has been set and the size cannot be determined from any of the receiver's image representations.

The size of an NSImage object must be set before it can be used. If the size of the image hasn't already been set when an image representation is added, the size is taken from the image representation's data. For EPS images, the size is taken from the image's bounding box. For TIFF images, the size is taken from the ImageLength and ImageWidth attributes.

Changing the size of an NSImage after it has been used effectively resizes the image. Changing the size invalidates all its caches and frees them. When the image is next composited, the selected representation will draw itself in an offscreen window to recreate the cache.
(Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.usesEPSOnResolutionMismatch as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: Whether EPS image representations are preferred when no other representations match the resolution of the device.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSImageMBS.width as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa Drawing MBS MacBase Plugin 7.2 Yes No No Yes, macOS only No
Function: The width of the image or zero.
Notes:
If no size has been set and the size cannot be determined from any of the receiver's image representations.
(Read only property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacBase Plugin.





Links
MBS FileMaker tutorial videos