Platforms to show: All Mac Windows Linux Cross-Platform
Back to NSAttributedStringMBS class.
NSAttributedStringMBS.NSExcludedElementsDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An Array object containing string objects, representing HTML elements not to be used in generated HTML.
Available in Mac OS X v10.4 and later.
NSExcludedElementsDocumentAttribute allows control over the tags used. The recognized values in the NSExcludedElementsDocumentAttribute array are (case-insensitive) HTML tags, plus DOCTYPE (representing a doctype declaration) and XML (representing an XML declaration). By default, if this attribute is not present, the excluded elements will be those deprecated in HTML 4 (APPLET, BASEFONT, CENTER, DIR, FONT, ISINDEX, MENU, S, STRIKE, and U) plus XML. If XML is on the list, HTML forms are used; if XML is not on the list, XHTML forms are used where there is a distinction.
NSAttributedStringMBS.NSExpansionAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing floating point value, as log of expansion factor to be applied to glyphs
Default 0.0, no expansion
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSFileTypeDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string indicating which document type was used to interpret the document, specified as a UTI; for reading, this is available along with NSDocumentTypeDocumentAttribute, but for writing the two are mutually exclusive.
Available in Mac OS X v10.6 and later.
NSAttributedStringMBS.NSFileTypeDocumentOption as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string indicating a document type to be forced when loading the document, specified as a UTI string; mutually exclusive with NSDocumentTypeDocumentOption.
Available in Mac OS X v10.6 and later.
NSAttributedStringMBS.NSFontAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSFont
Default Helvetica 12-point
Some examples using this method:
NSAttributedStringMBS.NSForegroundColorAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSColor
Default blackColor
Available in Mac OS X v10.0 and later.
Some examples using this method:
NSAttributedStringMBS.NSGlyphInfoAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The name of an NSGlyphInfo object.
NSLayoutManager assigns the glyph specified by this glyph info to the entire attribute range, provided that its contents match the specified base string, and that the specified glyph is available in the font specified by NSFontAttributeName.
Available in Mac OS X v10.2 and later.
NSAttributedStringMBS.NSHTMLTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Hypertext Markup Language (HTML) document.
NSAttributedStringMBS.NSHyphenationFactorDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number, containing a float; 0 = off, 1 = full hyphenation.
Mac OS X v10.3 and earlier string constant is "HyphenationFactor".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSKernAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing floating point value, as points by which to modify default kerning
Default nil, use default kerning specified in font file; 0.0, kerning off; non-zero, points by which to modify default kerning
Available in Mac OS X v10.0 and later.
NSAttributedStringMBS.NSKeywordsDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Array of string, containing keywords.
Available in Mac OS X v10.4 and later.
Some examples using this method:
NSAttributedStringMBS.NSLeftMarginDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number, containing a float, in points.
Mac OS X v10.3 and earlier string constant is "LeftMargin".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSLigatureAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing integer
Default 1, standard ligatures; 0, no ligatures; 2, all ligatures.
NSAttributedStringMBS.NSLinkAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSURL (preferred) or string
Default nil, no link
Available in Mac OS X v10.0 and later.
Some examples using this method:
NSAttributedStringMBS.NSMacSimpleTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Macintosh SimpleText document.
NSAttributedStringMBS.NSManagerDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string containing the name of the author's manager.
Available in Mac OS X v10.6 and later.
NSAttributedStringMBS.NSMarkedClauseSegmentAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing an integer, as an index in marked text indicating clause segments
Available in Mac OS X v10.5 and later.
NSAttributedStringMBS.NSModificationTimeDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSDate containing the modification date of the document contents.
Available in Mac OS X v10.4 and later.
Some examples using this method:
NSAttributedStringMBS.NSObliquenessAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing floating point value, as skew to be applied to glyphs
Default 0.0, no skew
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSOfficeOpenXMLTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
ECMA Office Open XML text document format.
Available in Mac OS X v10.5 and later.
NSAttributedStringMBS.NSOpenDocumentTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
OASIS Open Document text document format.
Available in Mac OS X v10.5 and later.
NSAttributedStringMBS.NSPaperSizeDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSValue, containing NSSize.
Mac OS X v10.3 and earlier string constant is "PaperSize".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSParagraphStyleAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSParagraphStyle
Default as returned by the NSParagraphStyle method defaultParagraphStyle
NSAttributedStringMBS.NSPlainTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Plain text document.
NSAttributedStringMBS.NSPrefixSpacesDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An Number containing an integer (default 0) representing the number of spaces per level by which to indent certain nested HTML elements.
Available in Mac OS X v10.4 and later.
NSPrefixSpacesDocumentAttribute allows some control over formatting.
NSAttributedStringMBS.NSReadOnlyDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number, containing int. If missing or 0 or negative, not read only; 1 or more, read only.
Note that this has nothing to do with the file system protection on the file, but instead can affect how the file should be displayed to the user.
Mac OS X v10.3 and earlier string constant is "ReadOnly".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSRightMarginDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number, containing a float, in points.
Mac OS X v10.3 and earlier string constant is "RightMargin".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSRTFDTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Rich text format with attachments document.
NSAttributedStringMBS.NSRTFTextDocumentType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Rich text format document.
NSAttributedStringMBS.NSShadowAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSShadow
Default nil, no shadow.
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSSpellingStateAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An integer value. Defaults to 0, indicating no grammar or spelling error. See "NSSpellingStateAttributeName Flags" for possible values.
This key is available in Mac OS X v10.2 and later, but its interpretation changed in Mac OS X v10.5. Previously, any non-zero value caused the spelling indicator to be displayed. For Mac OS X v10.5 and later, the (integer) value is treated as being composed of the spelling and grammar flags.
Available in Mac OS X v10.5 and later.
NSAttributedStringMBS.NSStrikethroughColorAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSColor
Default nil, same as foreground color
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSStrikethroughStyleAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing integer
Default 0, no strikethrough. See "Underlining Patterns", "Underlining Styles", and "Underline Masks" in Apple Documentation for mask values.
Available in Mac OS X v10.3 and later.
Some examples using this method:
NSAttributedStringMBS.NSStrokeColorAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSColor
Default nil, same as foreground color
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSStrokeWidthAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing floating point value, as percent of font point size
Default 0, no stroke; positive, stroke alone; negative, stroke and fill (a typical value for outlined text would be 3.0)
Available in Mac OS X v10.3 and later.
NSAttributedStringMBS.NSSubjectDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string containing subject of document.
Available in Mac OS X v10.4 and later.
Some examples using this method:
NSAttributedStringMBS.NSSuperscriptAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing integer
Default 0
Some examples using this method:
NSAttributedStringMBS.NSTextAlternativesAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An NSTextAlternatives object. Used primarily as a temporary attribute, with primaryString equal to the substring for the range to which it is attached, and alternativeStrings representing alternatives for that string that may be presented to the user.
Available on OS X 10.8 and newer.
NSAttributedStringMBS.NSTextEffectAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSString, default nil: no text effect
NSAttributedStringMBS.NSTextEffectLetterpressStyle as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available on Mac OS X 10.10 or newer.
NSAttributedStringMBS.NSTextEncodingNameDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An string object containing the name, IANA or otherwise, of a text encoding to be used; mutually exclusive with NSCharacterEncodingDocumentAttribute.
Available in Mac OS X v10.4 and later.
Either NSCharacterEncodingDocumentAttribute or NSTextEncodingNameDocumentAttribute may be used to control the encoding used for generated HTML; character entities are used for characters not representable in the specified encoding.
NSAttributedStringMBS.NSTextEncodingNameDocumentOption as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string containing the name, IANA or otherwise, of a text encoding to override any encoding specified in an HTML document. Mutually exclusive with @"CharacterEncoding". Previous string constant was @"TextEncodingName".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSTextLayoutSectionOrientation as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An Number containing an NSTextLayoutOrientation value. The default value is NSTextLayoutOrientationHorizontal.
Available in Mac OS X v10.7 and later.
NSAttributedStringMBS.NSTextLayoutSectionRange as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An NSValue containing an NSRange representing a character range. The default value is a range covering the entire string.
Available in Mac OS X v10.7 and later.
NSAttributedStringMBS.NSTextLayoutSectionsAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An Array containing dictionarys. Each dictionary describes a layout orientation section. The dictionary can have two attributes: NSTextLayoutSectionOrientation and NSTextLayoutSectionRange. When there is a gap between sections, it's assumed to have NSTextLayoutOrientationHorizontal.
Available in Mac OS X v10.7 and later.
NSAttributedStringMBS.NSTextSizeMultiplierDocumentOption as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Specifies a scale factor for font sizes.. Number containing float, default 1.0; for HTML only, corresponding to WebView's textSizeMultiplier.
There is no textual equivalent for Mac OS X v10.3.
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSTimeoutDocumentOption as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Number containing float. Time in seconds to wait for a document to finish loading. Previous string constant was @"Timeout".
Available in Mac OS X v10.4 and later.
NSAttributedStringMBS.NSTitleDocumentAttribute as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string containing document title.
Available in Mac OS X v10.4 and later.
Some examples using this method:
NSAttributedStringMBS.NSToolTipAttributeName as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Cocoa Text | MBS MacBase Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
string
Default nil, no tooltip
Available in Mac OS X v10.3 and later.
The items on this page are in the following plugins: MBS MacBase Plugin.