NSAttributedStringMBS.attributedStringWithAttachment(attachment as NSTextAttachmentMBS) as NSAttributedStringMBS

dim content as MemoryBlock = "Hello World"
dim f as NSFileWrapperMBS = NSFileWrapperMBS.initRegularFileWithContents(content)
f.filename = "HelloWorld.txt"

dim a as new NSTextAttachmentMBS(f)
dim s as NSAttributedStringMBS = NSAttributedStringMBS.attributedStringWithAttachment(a)

This is a convenience method for creating an attributed string containing an attachment using NSAttachmentCharacter as the base character.

NSAttributedStringMBS.attributedStringWithAttributedString(text as NSAttributedStringMBS) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithDocFormat(data as memoryblock) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithDocFormat(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.attributedStringWithDocFormat(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithDocFormat(data as memoryblock) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithHTML(data as memoryblock) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithHTML(data as memoryblock, BaseURL as string) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, BaseURL as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithHTML(data as memoryblock, BaseURL as string) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithHTML(data as memoryblock) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, BaseURL as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithHTML(data as memoryblock, BaseURL as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithHTML(data as memoryblock) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, BaseURL as string) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithHTML(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithHTML(data as memoryblock) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, BaseURL as string) as NSAttributedStringMBS
• attributedStringWithHTML(data as memoryblock, BaseURL as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithHTMLOld(data as string) as NSAttributedStringMBS

With plugin version 9.4 the attributedStringWithHTML method uses the system function to parse html. The old plugin function is available with the name attributedStringWithHTMLOld.

NSAttributedStringMBS.attributedStringWithPath(file as folderitem) as NSAttributedStringMBS

// load rtfd file into textarea
dim file as FolderItem = SpecialFolder.Desktop.Child("test.rtfd")
dim n as NSAttributedStringMBS = NSAttributedStringMBS.attributedStringWithPath(file)
dim t as NSTextViewMBS = TextArea1.NSTextViewMBS
t.textStorage.setAttributedString(n)

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithPath(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithPath(path as string) as NSAttributedStringMBS
• attributedStringWithPath(path as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

Some examples using this method:

• /MacControls/TextEdit MBS
• /MacControls/TextView advanced

NSAttributedStringMBS.attributedStringWithPath(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithPath(file as folderitem) as NSAttributedStringMBS
• attributedStringWithPath(path as string) as NSAttributedStringMBS
• attributedStringWithPath(path as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithPath(path as string) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithPath(file as folderitem) as NSAttributedStringMBS
• attributedStringWithPath(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithPath(path as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithPath(path as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithPath(file as folderitem) as NSAttributedStringMBS
• attributedStringWithPath(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithPath(path as string) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithRTF(data as memoryblock) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithRTF(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

Some examples using this method:

• /Win/RTF Windows

NSAttributedStringMBS.attributedStringWithRTF(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithRTF(data as memoryblock) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithRTFD(data as memoryblock) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithRTFD(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithRTFD(data as memoryblock, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithRTFD(data as memoryblock) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithString(text as string) as NSAttributedStringMBS

// create Hello World in red
dim a as NSAttributedStringMBS = NSAttributedStringMBS.attributedStringWithString("Hello World")
dim m as NSMutableAttributedStringMBS = a.mutableCopy

m.addAttribute(a.NSForegroundColorAttributeName, NSColorMBS.redColor, new NSRangeMBS(0, m.length))

// put it in a textarea
TextArea1.NSTextViewMBS.textStorage.setAttributedString m

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithString(text as string, withAttributes as dictionary) as NSAttributedStringMBS

Some examples using this method:

• /MacControls/HUDPopupMenu
• /MacControls/Label with Color

NSAttributedStringMBS.attributedStringWithString(text as string, withAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithString(text as string) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithURL(file as folderitem) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithURL(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithURL(url as string) as NSAttributedStringMBS
• attributedStringWithURL(url as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithURL(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithURL(file as folderitem) as NSAttributedStringMBS
• attributedStringWithURL(url as string) as NSAttributedStringMBS
• attributedStringWithURL(url as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithURL(url as string) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithURL(file as folderitem) as NSAttributedStringMBS
• attributedStringWithURL(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithURL(url as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

NSAttributedStringMBS.attributedStringWithURL(url as string, byref DocumentAttributes as dictionary) as NSAttributedStringMBS

documentAttributes: Optional dictionary to receive the attributes.

See also:

• attributedStringWithURL(file as folderitem) as NSAttributedStringMBS
• attributedStringWithURL(file as folderitem, byref DocumentAttributes as dictionary) as NSAttributedStringMBS
• attributedStringWithURL(url as string) as NSAttributedStringMBS

NSAttributedStringMBS.FromClipboard as NSAttributedStringMBS

NSAttributedStringMBS.NSAttachmentAttributeName as string

NSTextAttachment
Default nil, no attachment

NSAttributedStringMBS.NSAuthorDocumentAttribute as string

// get some attributed text:
dim t as new NSAttributedStringMBS
call t.initWithString("Hello World")

// set document attributes
dim dic as new Dictionary
dic.Value(t.NSAuthorDocumentAttribute) = "Test User"

// get rtf
dim rtf as string = t.RTFFromRange(dic)

// write to file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.rtf")
dim b as BinaryStream = BinaryStream.Create(f, true)
b.Write rtf

string containing author name.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.NSBackgroundColorAttributeName as string

// add background color for text in text area:

TextArea1.Text = "Hello"

Dim tv As NSTextViewMBS = TextArea1.NSTextViewMBS
Dim ts As NSTextStorageMBS = tv.TextStorage

Dim value As Color = &cFF0000

Dim offset As Integer = 0
Dim length As Integer = 5

Dim range As NSRangeMBS = NSMakeRangeMBS( offset, length )
ts.AddAttribute( NSAttributedStringMBS.NSBackgroundColorAttributeName, value, range )

NSColor
Default nil, no background

Some examples using this method:

• /MacCocoa/SelTextBackColor

NSAttributedStringMBS.NSBackgroundColorDocumentAttribute as string

NSColor, representing the document-wide page background color.
Mac OS X v10.3 and earlier string constant is "BackgroundColor".
For applications linked on versions prior to Mac OS X v10.5, HTML import sets the NSBackgroundColorDocumentAttribute to NSColorMBS.whiteColor in cases in which the HTML does not specify a background color. For applications linked on Mac OS X v10.5 and later, no NSBackgroundColorDocumentAttribute is set in these cases.
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSBaselineOffsetAttributeName as string

Number containing floating point value, as points offset from baseline
Default 0.0

NSAttributedStringMBS.NSBaseURLDocumentOption as string

For HTML documents; NSURL containing base URL. Previous string constant was @"BaseURL"
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSBottomMarginDocumentAttribute as string

// get some attributed text:
dim t as new NSAttributedStringMBS
call t.initWithString("Hello World")

// set document attributes
dim dic as new Dictionary
dic.Value(t.NSBottomMarginDocumentAttribute) = 20
dic.Value(t.NSLeftMarginDocumentAttribute) = 20
dic.Value(t.NSRightMarginDocumentAttribute) = 20
dic.Value(t.NSTopMarginDocumentAttribute) = 20
dic.Value(t.NSAuthorDocumentAttribute) = "Test User"

// get rtf
dim rtf as string = t.RTFFromRange(dic)

// write to file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.rtf")
dim b as BinaryStream = BinaryStream.Create(f, true)
b.Write rtf

Number, containing a float, in points.
Mac OS X v10.3 and earlier string constant is "BottomMargin".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSCategoryDocumentAttribute as string

string containing the document's category.
Available in Mac OS X v10.6 and later.

NSAttributedStringMBS.NSCharacterEncodingDocumentAttribute as string

Number, containing an int specifying the stringEncoding for the file; for reading and writing plain text files and writing HTML; default for plain text is the default encoding; default for HTML is UTF-8.
Mac OS X v10.3 and earlier string constant is "CharacterEncoding".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSCharacterEncodingDocumentOption as string

For plain text documents; Number containing the unsigned int stringEncoding to override any encoding specified in an HTML document. Previous string constant was @"CharacterEncoding".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSCharacterShapeAttributeName as string

An integer value. The value is interpreted as Apple Type Services kCharacterShapeType selector + 1.
The default value is 0 (disable). 1 is kTraditionalCharactersSelector, and so on. Refer to <ATS/SFNTLayoutTypes.h> and "Font Features" in ATSUI Programming Guide for additional information.
Available in Mac OS X v10.0 and later.

NSAttributedStringMBS.NSCocoaVersionDocumentAttribute as string

Number, containing a float. For RTF files only, stores the version of Cocoa with which the file was created. Absence of this value indicates RTF file not created by Cocoa or its predecessors.
Values less than 100 are pre–Mac OS X; 100 is Mac OS X v10.0 or v10.1; 102 is Mac OS X v10.2 and 10.3; values greater than 102 correspond to values of NSAppKitVersionNumber on Mac OS X v10.4 and later.
Mac OS X v10.3 and earlier string constant is "CocoaRTFVersion".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSCommentDocumentAttribute as string

string containing document comments.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.NSCompanyDocumentAttribute as string

string containing company or organization name.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.NSConvertedDocumentAttribute as string

Number, containing an int. Indicates whether the file was converted by a filter service.
If missing or 0, the file was originally in the format specified by document type. If negative, the file was originally in the format specified by document type, but the conversion to NSAttributedString may have been lossy. If 1 or more, it was converted to this type by a filter service.
Mac OS X v10.3 and earlier string constant is @"Converted".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSCopyrightDocumentAttribute as string

string containing document copyright info.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.NSCreationTimeDocumentAttribute as string

NSDate containing the creation date of the document; note that this is not the file system creation date of the file, but of the document.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes

NSAttributedStringMBS.NSCursorAttributeName as string

NSCursor
Default as returned by the NSCursor method IBeamCursor
Available in Mac OS X v10.3 and later.

NSAttributedStringMBS.NSDefaultAttributesDocumentAttribute as string

NSDictionary containing attributes to be applied to plain files. Used by reader methods. This key in options can specify the default attributes applied to the entire document contents. The document attributes can contain this key indicating the actual attributes used.
Available on Mac OS X 10.11.

NSAttributedStringMBS.NSDefaultAttributesDocumentOption as string

For plain text documents; Dictionary containing attributes to be applied to plain files. Previous string constant was @"DefaultAttributes".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSDefaultTabIntervalDocumentAttribute as string

Number containing a float. Represents the document-wide default tab stop interval.
Mac OS X v10.3 and earlier string constant is "DefaultTabInterval".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSDocFormatTextDocumentType as string

Microsoft Word document.

NSAttributedStringMBS.NSDocumentTypeDocumentAttribute as string

How the document was interpreted; one of the values in "Document Types."
Mac OS X v10.3 and earlier string constant is "DocumentType".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSDocumentTypeDocumentOption as string

One of the document types described in "Document Types," indicating a document type to be forced when loading the document. Previous string constant was @"DocumentType".
Available in Mac OS X v10.4 and later.

NSAttributedStringMBS.NSEditorDocumentAttribute as string

string containing name of person who last edited the document.
Available in Mac OS X v10.4 and later.

Some examples using this method:

• /MacBase/NSAttributedString document attributes