HTML to MAML Converter · HTML to MAML Converter Using the Converter This topic will walk you through using the converter to convert a batch of HTML files to MAML topics. Using the

HTMLtoMAMLConverter

WelcomeWelcometotheHTMLtoMAMLConverter.ThisutilityisusedtoconvertHTMLfilestoMicrosoftAssistanceMarkupLanguage(MAML)topicfilessothattheycanbecompiledintohelpfilesusingtheSandcastleHelpFileBuilderwiththeselectedpresentationstyle'slookandfeel.Theutilityislocatedinthe.\Extrasfolderundertheroothelpfilebuilderinstallationfolder(typicallyC:\ProgramFiles(x86)\EWSoftware\SandcastleHelpFileBuilder).

WhatisConceptualContent?Conceptualcontentallowsyoutodefinenon-APIdocumentationthatisincludedinthehelpfileforusagenotes,walkthroughs,tutorials,etc.InsteadofHTML,conceptualcontenttopicsuseMicrosoftAssistanceMarkupLanguage(MAML).ThisisbasicallyXMLconformingtoawelldefinedschemathatdescribesthestructureoftheconceptualcontentmuchlikeXMLcommentsdescribethestructureofthecodecomments.ThereisnolayoutorstyleinformationwithintheMAMLfiles.Instead,theyareranthroughaseriesofXSLtransformationsusingSandcastle'sBuildAssemblertoolsimilartothereference(API)contentsothattheymatchitinappearanceandfeatures.ThisallowsyoutoutilizethevariousSandcastleandthird-partybuildcomponentstoalterandextendthepresentationstyleusedinthetopics.

Theterm"conceptualcontent"isactuallyacatch-alltermusedtorefertothevarioustypesofcontentthatmayappearinthehelpfile.MAMLactuallydefinesseveraldifferentcontenttypes,eachusedforaspecifictypeofdocument(conceptual,glossary,how-to,reference,etc.).EachtypehasaspecificstructurewithvariousrequiredandoptionalXMLelements.FormoreinformationonMAML,thevarioustopictypes,andthevariouselementsthatyoucanusewithinthem,seetheSandcastleMAMLGuide.

TheConverterUtilityThepurposeofthisutilityistoquicklyconvertabatchofHTMLfiles(or.topicfilesusedbytheSandcastleHelpFileBuilder)intoMAMLtopicstosaveyoufromhavingtodoitmanually.SincetheconversiontoMAMLisnotperfect,youwillstillneedtoreviewthetopicsafterwardstocleanupanyunresolvedissuesandToDoitems

https://GitHub.com/EWSoftware/SHFB


notedintheconversionlog.TheconverterwilltransformtheHTMLtopicsintothegenericConceptualtopicformat.IfyourequirethatatopicconformtooneoftheotherMAMLtopicformatssuchasWalkthrough,HowTo,Glossary,etc.youwillneedtomakethenecessaryadjustmentsafterwards.

SeeAlsoOtherResourcesUsingtheConverterVersionHistoryLinkstoResources

Copyright©2008-2015,EricWoodruff,Allrightsreserved

[email protected]


mailto:Eric%40EWoodruff.us?Subject=HTML to MAML Converter

HTMLtoMAMLConverter

LicenseThistopiccontainsthefollowingsections:

MicrosoftPublicLicense(Ms-PL)CopyrightNotices

MicrosoftPublicLicense(Ms-PL)Thislicensegovernsuseoftheaccompanyingsoftware.Ifyouusethesoftware,youacceptthislicense.Ifyoudonotacceptthelicense,donotusethesoftware.

1. Definitions

Theterms"reproduce,""reproduction,""derivativeworks,"and"distribution"havethesamemeaninghereasunderU.S.copyrightlaw.

A"contribution"istheoriginalsoftware,oranyadditionsorchangestothesoftware.

A"contributor"isanypersonthatdistributesitscontributionunderthislicense.

"Licensedpatents"areacontributor'spatentclaimsthatreaddirectlyonitscontribution.

2. GrantofRights

(A)CopyrightGrant-Subjecttothetermsofthislicense,includingthelicenseconditionsandlimitationsinsection3,eachcontributorgrantsyouanon-exclusive,worldwide,royalty-freecopyrightlicensetoreproduceitscontribution,preparederivativeworksofitscontribution,anddistributeitscontributionoranyderivativeworksthatyoucreate.

(B)PatentGrant-Subjecttothetermsofthislicense,includingthelicenseconditionsandlimitationsinsection3,eachcontributorgrantsyouanon-exclusive,worldwide,royalty-freelicenseunderitslicensedpatentstomake,havemade,use,sell,offerforsale,import,and/orotherwisedisposeofitscontributioninthesoftwareorderivativeworksofthecontributioninthesoftware.

3. ConditionsandLimitations

(A)NoTrademarkLicense-Thislicensedoesnotgrantyourightstouseanycontributors'name,logo,ortrademarks.

(B)Ifyoubringapatentclaimagainstanycontributoroverpatentsthatyouclaimareinfringedbythesoftware,yourpatentlicensefromsuchcontributortothesoftwareendsautomatically.

(C)Ifyoudistributeanyportionofthesoftware,youmustretainallcopyright,patent,trademark,andattributionnoticesthatarepresentinthesoftware.

(D)Ifyoudistributeanyportionofthesoftwareinsourcecodeform,youmaydosoonlyunderthislicensebyincludingacompletecopyofthislicensewithyourdistribution.Ifyoudistributeanyportionofthesoftwareincompiledorobjectcodeform,youmayonlydosounderalicensethatcomplieswiththislicense.

(E)Thesoftwareislicensed"as-is."Youbeartheriskofusingit.Thecontributorsgivenoexpresswarranties,guaranteesorconditions.Youmayhaveadditionalconsumerrightsunderyourlocallawswhichthislicensecannotchange.Totheextentpermittedunderyourlocallaws,thecontributorsexcludetheimpliedwarrantiesofmerchantability,fitnessforaparticularpurposeandnon-infringement.

CopyrightNoticesAllcodeisCopyright©2006-2008,EricWoodruff,AllRightsReserved.


[email protected]

http://www.ewoodruff.us



HTMLtoMAMLConverter

UsingtheConverterThistopicwillwalkyouthroughusingtheconvertertoconvertabatchofHTMLfilestoMAMLtopics.

UsingtheConverter1. Theconverterisaconsolemodeapplication.Assuch,opena

commandpromptinordertorunit.Theutilityislocatedinthe.\Extrasfolderundertheroothelpfilebuilderinstallationfolder(typicallyC:\ProgramFiles(x86)\EWSoftware\SandcastleHelpFileBuilder).

Note

TheconverterusesanXMLfilethatcontainstheconversionrules.Thisfilemustresideinthesamefolderastheconverter'sexecutable.

2. Theconvertertakesafoldernamecontainingthefilestoconvertasthefirstparameterandthenameofanewfolderinwhichtoplacetheconvertedtopicsandsupportingfilesasthesecondparameter.Thefoldernamesmustbedifferentbutthenewfolderdoesnothavetoexistandwillbecreatedifnecessary.Belowisanexamplecommandline:

Anoptionalparameter,/companion,canalsobespecifiedtocreatecompanionfilesfortheconvertedtopics.Thisisusefulifyourdocumentationtool,suchasDocProject,makesuseofthemtostorethetopictitle,helpattributes,andindexkeywords.

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content

Copy

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content/companion

Copy

ExampleCommandLine

CreateOptionalCompanionFiles

Anoptionalparameter,/moveIntro,canalsobespecifiedtoindicatethattheconvertershouldmoveanytopictextprecedingthefirstsectionelementcreatedintotheintroductionelement.ThisoptionmayproducebetterresultsincaseswhereyourHTMLtopicscontainleadingtextbeforethefirstheaderelement,suchasanH1element,thatshouldappearintheMAMLtopic'sintroductionelement.IfyourtopicslackanHTMLheaderelement,thisoptionwilltypicallymovetheentiretopictextintotheintroductionelementwhichisprobablynotwantedandtheoptionshouldbeomitted.Inthatcase,adefaultintroductionelementisinsertedintoeachtopicandyoucanmovetextintoitduringtheclean-upphase.

Note

Whilethedestinationfolderwillbecreatedifitdoesnotalreadyexist,itwillnotbeclearedofanyexistingcontent.Assuch,youcanconvertmultiplebatchesoffilesintoonefolder.However,youshouldrenametheconversionlogandthesupportingfilesbetweenrunsifyouwanttokeepthem.

3. Astheconverterruns,itwritesinformationtotheconsoleasitgoes.Thisinformationisalsosavedtoalogfileinthedestinationfolder.

4. Oncefinished,thereviewprocesscanbegintocleanupanyissuesandToDoitemsintheconvertedtopics.Thelogfilecanhelpyoulocateitemsthatneedattention.

SeeAlsoOtherResourcesTheConversionProcessAdditionalOutputFilesWarningsandToDoItemsCommonIssuesandSolutions

ConvertHtmlToMaml.exeC:\MyLibrary\DocC:\MyLibrary\Content/moveIntro

CopyMoveLeadingTexttoIntroduction


[email protected]



HTMLtoMAMLConverter

TheConversionProcessUnlikeMAMLtopicswhichmustbewell-formedXML,HTMLfilesarenotnecessarilyasstrictintheirconformancetosuchrules.Endtagsarenotalwayspresent,the"/"inself-closingtagsisnotalwayspresent,entitiesarenotalwaysencodedcorrectlyifatall,etc.Assuch,theHTMLtoMAMLconverterextractskeypartsoftheHTMLfilesandusesaseriesofregularexpressionspairedwithmatchevaluatorstoaltertheHTMLelementsbyreplacingthemwiththeirMAMLequivalentsorremovingthemaltogether.

WhilethiswillnotguaranteeavalidMAMLtopic,itwillguaranteethatnoinformationislostduringtheconversion.Buildingtheconvertedtopicsrevealsanymissingendtags,unencodedentities,etc.whichareeasilyfixedbyeditingthetopics.

TheconversionrulesarestoredinanXMLconfigurationfile.Thisfilemustresideinthesamelocationastheconverter'sexecutable.

TheConversionProcessConversionofatopicfollowsthisgeneralprocedureusingtheruledefinitionsfoundintheconfigurationfile:

1. Extractthekeypartsofthetopic(metadatasuchasthetitle,attributes,andindexkeywords,andthebodytext).

2. Replacenamedentitieswiththeirnumericequivalent.

3. ReplacemarkupwrapperHTMLelementswithaplaceholderinthetextsoasnottoaltertheircontentinlaterprocessing.

4. RemoveallHTMLelementswithnoMAMLequivalent.

5. ReplaceallHTMLelementsthatdohaveMAMLequivalents.

6. ThefollowingHTMLelementsareprocessedbasedonthecontextinwhichtheyareused:

a-LinkstotopicsandexternalURLs

code-Inlinecodeandcodeblocks

h1-h6-Sectionheadings

img-Imagelinks

see-SeeAlsoreferences

Theseelementsshouldnotappearinanyoftheotherrules.

7. Oncedone,themarkupwrapperplaceholdersarereplacedwiththeiractualmarkupenclosedinaMAMLmarkupelement.

8. Theconvertedtopicissavedtothedestinationfolderalongwithsomesupportingfiles.

SeeAlsoOtherResourcesUsingtheConverter


[email protected]



HTMLtoMAMLConverter

MetadataTopicElementsCertaintopicelementsnotrepresentedintherulesfilearesearchedforinordertoextractcommonmetadatathatwillbeassociatedwiththeconvertedtopicfiles:

TheTitleElementIndexKeywordElementsHelpAttributeElementsSandcastleHelpFileBuilderSpecialCommentTags

Note

Allelementnamesarematchedcase-insensitively.

TheTitleElementTheHTMLfileshouldcontainastandardtitleelementthatdefinesthepagetitle.Ifnotfound,itwillbeleftblankinanyofthesupportingcontentfiles.

IndexKeywordElementsIftheparserfindsanyMSHelp:Keywordelements,itwillextracttheindexnameandthetermandwillsavethemtothesupportingcontentfiles.

HelpAttributeElementsIftheparserfindsanyMSHelp:Attrelements,itwillextracttheattributenameandvalueandwillsavethemtothesupportingcontentfiles.Ifthenameoftheattributeis"Abstract",thecontentoftheattributeiswrittenouttothetopicfileinthesummaryelement.Thiselementbecomestheabstractwhenthetopiciscompiledforthehelpfile.

SandcastleHelpFileBuilderSpecialCommentTagsIfthefileparserfindsanyofthespecialcommenttagsusedbytheSandcastleHelpFileBuildersuchas@TOCExclude,@SplitTOC,@DefaultTopic,and@SortOrderitwillextractthemandusethemwhengeneratingthesupportingcontentfilestomaintaintheexistinglayoutofthetopics.

SeeAlsoOtherResourcesTheConversionProcess


[email protected]




HTMLtoMAMLConverter

ConversionRuleElementsTheconversionrulesaredefinedinanXMLfilethatconsistsoffivemainparts.Eachpartisdescribedinthefollowingtopics.Thedefaultrulesetshouldworkquitewellformostdocumentsbutyouarefreetoalterandextendtherulesshouldtheynotmeetyourrequirements.

TheConversionRulesElementsSelectatopicbelowtolearnmoreabouteachelement:

TheBodyExtractElement

EntitiesRules

MarkupWrapperRules

RemoveRules

ReplaceRules

Note

Withtheexceptionofentitynamevalues,allotherattributeandregularexpressionrulevaluesarematchedcase-insensitively.



[email protected]



HTMLtoMAMLConverter

TheBodyExtractElementThiselementdefinestheregularexpressionusedtoextractthebodyoftheHTMLdocument.

RuleProcessingBydefaultitextractsthe<body>(.htmlfiles)or<bodyText>(.topicfiles)elementcontent.The"body"partoftheregularexpressionmustbeanamedgroupcalledBody.Oneexamplewhereyoumightwanttomodifythisisifyourdocumentbodiescontainseveralsectionscontainedwithindivelements.Youcanaltertheexpressiontoextractthespecificdivthatcontainsjustthebodytextthusexcludingtheotherunwantedpartsofthedocument.

Note

SinceitresidesinanXMLfile,anyspecialcharactersintheexpressionsuchas<,>,&,",and'mustbeencodeasshownintheexamplebelow.Theregularexpressionismatchedcase-insensitively.

SeeAlsoOtherResourcesTheConversionProcessConversionRuleElements




<BodyExtractexpression="<\s*div\s*class="Main"[^>]*?>

(?<Body>.*?)<\s*/\s*div?\s*>"/>

CopyExampledivExtract


[email protected]


HTMLtoMAMLConverter

EntitiesRulesThissectiondefinesnamedentitiesthatmustbeconvertedtotheirnumericequivalentintheMAMLtopicfiles.

RuleProcessingThe.NETXMLparseronlyrecognizesthecommonASCIInamedentities(&,<,>,",and').OnceconvertedtoMAML,thetopicsareprocessedasXMLfilesand,assuch,anyothernamedentitiesinthetopicwillcausethebuildprocesstofail.ThissectiondefinesallothernamedentitiescommonlyfoundinHTMLfilesandtheirreplacementnumericequivalent.Duringconversion,anynamedentitiesfromthissectionfoundinatopicarereplacedwiththeirnumericform(i.e.©wouldbecome©).

TheentriesconsistofEntityelementswithanameattributethatdefinesthenamedentityandavalueattributethatdefinesthenumericvaluetouseasitsreplacement.

Note

Unliketheotherrules,entitynamevaluesarematchedcase-sensitivelyasthenumericvaluesforuppercaseandlowercasenamevaluesdifferasshownintheexamplebelow.

SeeAlso

<Entities>

<Entityname="Aacute"value="193"/>

<Entityname="aacute"value="225"/>

<Entityname="Acirc"value="194"/>

<Entityname="acirc"value="226"/>

</Entities>

CopyExampleEntitiesEntries

OtherResourcesTheConversionProcessConversionRuleElements


[email protected]



HTMLtoMAMLConverter

MarkupWrapperRulesThissectiondefinesHTMLelementsthatthemselvesorwhosecontentmustberetainedasHTMLintheconvertedtopics.

RuleProcessingCertainHTMLelementsmayneedspecialhandlinginordertoreplacetheminaMAMLtopicortheymayneedtobeleftas-is.Thissectionletsyoudefinesuchelements.Whenconverted,theaffectedelementiswrappedinaMAMLmarkupelementprecededbya""comment.Duringthereviewprocess,youcandecidewhethertokeeptheelementorremoveitinfavororsomealternatecontent.

TheentriesconsistofTagelementswithanameattributethatdefinestheHTMLelementtobewrapped.

Note

Allnamevaluesarematchedcase-insensitively.

Caution

Itisnotrecommendedthatanyotherelementsbeaddedtothecurrentlydefinedlist.WhileitispossibletopassthroughHTMLusingthemarkupMAMLelement,itshouldnotbeabusednorshoulditbeusedwhereMAMLequivalentsdoexist.

<MarkupWrapper>

<Tagname="applet"/>

<Tagname="bgsound"/>

<Tagname="button"/>

<Tagname="embed"/>

<Tagname="fieldset"/>

<Tagname="form"/>

CopyMarkupEntries



[email protected]

<Tagname="frameset"/>

<Tagname="iframe"/>

<Tagname="ilayer"/>

<Tagname="input"/>

<Tagname="label"/>

<Tagname="layer"/>

<Tagname="map"/>

<Tagname="noembed"/>

<Tagname="nolayer"/>

<Tagname="noscript"/>

<Tagname="object"/>

<Tagname="script"/>

<Tagname="select"/>

<Tagname="sound"/>

<Tagname="textarea"/>

<Tagname="xml"/>

</MarkupWrapper>



HTMLtoMAMLConverter

RemoveRulesThissectiondefinesHTMLelementsthatmustberemovedfromtheconvertedtopicsbecausetheylackaMAMLequivalent.

RuleProcessingCertainHTMLelementshavenoMAMLequivalentandservenopurposeiftheyappearoutsideofanelementhandledbythemarkupwrapperrules.Insuchcases,theseelementsaresimplyremoved.Anytextwithintheelementswillappearinthetopicasnormaltext.

TheentriesconsistofTagelementswithanameattributethatdefinestheHTMLelementtoberemoved.

Note

Allnamevaluesarematchedcase-insensitively.

<Remove>

<Tagname="area"/>

<Tagname="base"/>

<Tagname="basefont"/>

<Tagname="bdo"/>

<Tagname="blink"/>

<Tagname="center"/>

<Tagname="col"/>

<Tagname="colgroup"/>

<Tagname="del"/>

<Tagname="font"/>

<Tagname="frame"/>

<Tagname="include"/>

<Tagname="ins"/>

<Tagname="isindex"/>

<Tagname="keygen"/>

CopyRemoveEntries



[email protected]

<Tagname="legend"/>

<Tagname="link"/>

<Tagname="marquee"/>

<Tagname="meta"/>

<Tagname="multicol"/>

<Tagname="nextid"/>

<Tagname="nobr"/>

<Tagname="noframes"/>

<Tagname="optgroup"/>

<Tagname="option"/>

<Tagname="param"/>

<Tagname="plaintext"/>

<Tagname="rt"/>

<Tagname="ruby"/>

<Tagname="s"/>

<Tagname="spacer"/>

<Tagname="strike"/>

<Tagname="style"/>

<Tagname="tbody"/>

<Tagname="tfoot"/>

<Tagname="wbr"/>

</Remove>



HTMLtoMAMLConverter

ReplaceRulesThissectiondefinesHTMLelementsthatcanbereplacedwithaMAMLequivalent.

RuleProcessingTherulesinthissectionmakeanattemptatreplacingHTMLelementswiththeclosestMAMLequivalent.TheentriesconsistofTagelementswithvariousattributecombinationsthatdefinetheHTMLelementanditsreplacement.NestedMatchelementscanbeusedtofurtherrefinehowthereplacementoccurs.

TheTagelementcancontainthefollowingattributes:

Attribute Purposename TheHTMLelementtoreplace.Thisattributeis

required.

startTag Thevaluetouseasthereplacementopeningtag.Ifomittedandnonestedmatchrulesaremet,theelementwillberemoved.Ifthereplacementvaluecontains"<"or">",thevalueisusedasaverbatimreplacement.Ifnotpresent,thereplacementiswrappedin"<"and">".Anyattributesandtheself-closing"/"areincludedifnecessary.

endTag Thevaluetouseasthereplacementclosingtag.Normally,thisisomittedandthestartTagvalueisusedfortheclosingtagaswell.However,ifitdiffers,thiscanbeusedtospecifythevalueforit.AswithstartTag,ifthereplacementvaluecontains"<"or">",thevalueisusedasaverbatimreplacement.Ifnotpresent,thereplacementiswrappedin"</"and">".

attributes ThiscanbeusedtodefineareplacementsetofattributesthatwillappearontheMAML

element.Ifomitted,allattributesfromtheHTMLelementareremovedandtheMAMLelementwillnothaveanyattributes.Ifsettothevalue"@Preserve",theHTMLattributeswillbepreservedandwillbeaddedasattributesonthereplacementMAMLelementas-is.Foranyothervalue,thespecifiedtextreplacestheHTMLattributes.IfstartTagcontains"<"or">",thisattributeisignored.

Note

Allnameandregularexpressionvaluesarematchedcase-insensitively.

DefiningAdditionalMatchRulesIncertaincases,itmaybenecessarytodefineadditionalmatchconditionstodefinethereplacementMAMLelement.Todothis,addoneormoreMatchelementsaschildrenoftherelatedTagelement.

TheMatchelementcancontainthesameattributesastheTagelementinanyneededcombination.Inaddition,ithasarequiredexpressionattributethatdefinestheregularexpressionusedtomatchthespecificinstanceofanHTMLelement.Ifamatchismade,theotherattributesontheMatchelementareusedinsteadoftheattributesontheparentTagelement.Ifnoneoftheexpressionsresultinamatch,theattributesontheparentTagelementareevaluatedasusual.

ExampleReplacementRulesNote

SincetheyresidesinanXMLfile,anyspecialcharactersintheexpressionssuchas<,>,&,",and'mustbeencodeasshownintheexamplebelow.

<Replace>

<Tagname="abbr"startTag="phrase"/>

<Tagname="b"startTag="legacyBold"/>

CopyExampleReplaceEntries



[email protected]

<Tagname="br"startTag="<para/>"/>

<Tagname="comment"startTag="<--"endTag="-->"

<Tagname="div">



<Matchexpression="class="deprecated""

attributes="class="warning""/>

</Tag>



<Tagname="pre"startTag="code"attributes="language="none"title="""



<Matchexpression="lang(uage)?="startTag="code"

</Tag>



<Tagname="span">

<Matchexpression="class="code""startTag

<Matchexpression="class="command""startTag

<Matchexpression="class="foreignPhrase""

</Tag>

</Replace>



HTMLtoMAMLConverter

Context-basedConversionsThefollowingHTMLelementsmustbeconvertedbasedontheircontextwithinthetopic.Sincethecontextishardtotranslateintoaneasilydefinedruleintherulesfile,theelementsdescribedinthistopicarehandledbytheapplicationitself.Assuch,theseelementsshouldnotappearinanyofthepreviouslydefinedrules.

AnchorElementsCodeElementsHeadingElementsImageElementsSeeElements

Note

Allelementnamesarematchedcase-insensitively.

AnchorElementsHTMLanchorelements(a)arereplacedasfollows:

Anchorswithanameattributeareassumedtobein-pagelinktargets.TheMAMLequivalentofsuchalinktargetisanaddressattributeonanelementsuchassection,definedTerm,listItem,etc.Tryingtoplaceanaddressattributeontheappropriateelementisalmostimpossiblesotheseanchortypesarereplacedwitha""commentforlaterreview.Awarningisalsowrittentothelogfile.

AnexceptionistargetsinsideofheadingHTMLelements.Ifproperlyformatted,thesewillbeconvertedtoaddresselementsontherelatedsectionelementwhentheheadingelementsareprocessed(seebelow).

Ifthelink'sURLcontains"://",startswith"mailto:",orthelinkspecifiesatargetattributeitisconvertedtoanexternalLink.

Allotherlinksareconvertedtolinkelements.IfthetopicID

cannotberesolvedusingthefilenamefromtheHTMLhrefattribute,itisreplacedwitha""commentforlaterreviewandawarningiswrittentothelogfile.

Note

Linkinnertextwillberetainedifitdiffersfromthetargettopic'stitle.Inaddition,anin-pagelinksuffixwillberetained(i.e.SomePage.htm#InPageLink).

CodeElementsThenormalcodeHTMLelementisequivalenttotheMAMLcodeInlineelement.However,tosupportconversionoftheSandcastleHelpFileBuilderoptionofincludingcodeblocksfromexternalfiles,thiselementisreplacedbasedonthefollowingcontexts:

Ifnoattributesarepresentontheelementandnocarriagereturn/linefeedsarepresentintheelement'sinnertext,itisreplacedwithaMAMLcodeInlineelement.

IfanyattributesarepresentontheHTMLelementorifitsinnertextcontainsmultiplecarriagereturn/linefeeds,itisreplacedwithaMAMLcodeelementandanyattributesarepreserved.

Intheeventthatnoattributesarepresentandonlyasinglecarriagereturn/linefeedpairarepresentintheinnertext,itisassumedthatthevaluesimplyspansalinebreakanditisreplacedwithacodeInlineelementinstead.

HeadingElementsHTMLheadingelements(h1throughh6)arereplacedwithasectionelement.Thecontentoftheheadingelementbecomesthesectiontitleandisplacedinthesection'stitleelement.Thetextfollowingtheheadingbecomesthecontentofthesection.Whenanewheadingelementisencountered,closingsectionelementsareinsertedasneeded.Closingsectionelementsarealsoaddedtotheendofthebodytextifatleastoneheadingwasencounteredtocloseoffthefinalsection.

Anchorelementsareprocessedbeforeheadingelements.Assuch,


ifanamedanchorisreplacedwithaToDocommentanditappearswithintheheadingtag,itwillbeconvertedtoanaddressattributeonthesectionautomaticallyasshownintheexamplebelow.Thissavesyoufromhavingtodoitmanuallybutyoushouldstillreviewtheupdatetomakesurethatitisappropriate.

MAMLsectionscanbenestedwithinoneanother.However,attemptingtodothisduringconversionwouldbeverydifficultandwouldmostlikelyresultinchangesthatwerenotintendedorarenotappropriate.Assuch,noattemptismadetonestsectionswithahigherheadingnumberintoprioroneswithalowerheadingnumber(i.enestingh2sectionswithinanh1section).Theheadingelementthatcausedthesectiontobecreatedisaddedinacommentfollowingthesectionelement.Youcanreviewthetopicafter

Seethe<ahref="#BuildLogFile">BuildLogFile</a>property

.

.

.

<h3><aclass="Reference"name="BuildLogFile">TheBuildLogFileProperty

<p>Sectioncontent</p>

Copy

Seethe<linkxlink:href="#BuildLogFile">BuildLogFile

.

.

.

<sectionaddress="BuildLogFile">

<title>TheBuildLogFileProperty</title>

<content>

<para>Sectioncontent</para>

</content>

</section>

Copy

OriginalHTML

ConvertedMAML

conversiontodecidewhethertoleavethetopicasitisorreworkthecontenttonestsectionswithinoneanother.

ImageElementsHTMLimageelements(img)arereplacedwithanexternalLinkifthesrcattributecontains"://".Ifnot,theimageisassumedtobelocaltotheprojectandisconvertedtoamediaLink.NotethatitisnotpossibletodeterminewhetherornottouseamediaLinkInlineelementinstead.Assuch,youwillneedtoupdatethelinkduringthereviewafterconversion.FormediaLinkelements,youmayneedtoaddacaptionelementifneededandotherattributestoproperlysettheimagealignmentaswell.

Whenanewimageisencountered,itisaddedtothemediacontentfilecreatedbytheconversionprocessandtheimagefileiscopiedtotheMedia\folderunderthedestinationfolder.Thesourceimagelocationisdeterminedbycombiningthesourceconversionfolderwiththepathfromthesrcattribute.Iftheimagefilecannotbefound,thereplacementelementisprefixedwitha""commentnotingthemissingfileandawarningiswrittentothelogfile.

SeeElementsTheSandcastleHelpFileBuildersupportsseeelementswithinadditionalcontentHTMLfiles.Whenencountered,theseareconvertedtolinkstothematchingAPImembertopics.Tomatchthisbehavior,ifaseeelementisencounteredduringconversion,itisconvertedtoanappropriatecodeEntityReferenceelement.

Thehelpfilebuilderhastheabilitytoresolveareferencebasedonapartialname.However,MAMLrequiresthatthenamebefullyqualified.Assuch,ifapartialnameisencountered,itwillstillbeconvertedbutawarningwillbewrittentothelogfile.Thesewillneedtobefixedduringthereviewtoreplacethemwiththeirfullyqualifiednames.



ConversionRuleElements


[email protected]



HTMLtoMAMLConverter

AdditionalOutputFilesThefollowingfilesarecreatedinadditiontotheconvertedtopicfilesandcanbefoundinthedestinationfolderaftertheconversionhascompleted.

_Conversion.logThisfilecontainstheoutputfromtheconversionprocess.RefertoittofindanywarningsandnotesonToDoitemsthatneedattention.

_ContentTokens.tokensTheSandcastleHelpFileBuilderallowscustomtagstoappearintheadditionalcontentfilesthatareresolvedatbuildtimeintoprojectpropertyvalues.SinceitisnotallowabletoplacethemdirectlyinMAMLtopics,theyareextractedandreplacedwithatoken.ThetagsinthetokenfilewillbereplacedatbuildtimewiththeirprojectvaluesandBuildAssemblerwillreplacethetokensinthetopicswiththeresultingtokenvalue.Ifnoreplacementtagsarefound,thetokenfilewillnotbecreated.

_ContentLayout.contentThisfilecontainsthecontentlayoutbasedontheconvertedtopics.Thiscanbeaddedtoahelpfilebuilderproject(version1.8.0.0orlater)alongwiththeconvertedfilesandfoldersandeditedtosetthelayoutofthetopicsinthecompiledhelpfile.Ifusingsomeotherdocumentationtool,youwillneedtoimportthetopicsanddefinetheirlayoutusingwhatevertoolsthatitmayprovide.

TheMediaFolderThisfolderwillcontainthemediafiles(images)foundduringtheconversionprocess.Thesefilescanbeaddedtothehelpproject.

Media\_MediaFiles.xmlThisfileisthemediacontentfilethatcontainstheimageIDsandalternatetextvaluesforimagesreferencedinmediaLinkelementsintheconvertedtopics.Itcanbeaddedtothehelpprojectorimporteddependingonhowyourdocumentationtoolmakesuseofsuchfiles.


SeeAlsoOtherResourcesTheConversionProcessWarningsandToDoItems


[email protected]



HTMLtoMAMLConverter

WarningsandToDoItemsThistopicdescribesthevariouswarningsandToDoitemsyouwillseeintheconversionlogfileandtheconvertedtopics.

WarningsThefollowingwarningsmayappearinthelogfile.

Warning:Foundunknowntag[tag]whichwillberemovedThiswarningappearsifanHTMLelementisencounteredthatisnotcoveredbyoneoftherulesdefinedintheconfigurationfile.Insuchcases,theunknowntagwillberemoved.

Warning:Imagefile'[file]'notfoundThiswarningappearswhenanHTMLimagelinkisconvertedtoamediaLinkandthesourcefilecouldnotbefound.Whilethelinkwillstillbecreatedandanentrymadeinthemediacontentfile,thecorrespondingsourcefilewillnotbefoundinthemediafolderafterconversion.Youwillneedtomanuallylocatethefileandaddittotheproject.

Warning:Namedanchor[id]needsreviewThiswarningappearswhenanHTMLanchorelementwithanameattributeisencountered.ThisisareminderthatyouwillneedtoeditthetopicandapplyanaddressattributewiththespecifiedIDtotheappropriateMAMLelement.RefertotheSandcastleMAMLGuideforinformationonwhichelementssupportanaddressattribute.

Warning:Referencetocodeentity[id]isnotfullyqualifiedThiswarningappearsifacodeEntityReferenceisaddedandthetargetspecifiedinthesourceHTMLfileisnotafullyqualifiedname.Youwillneedtoupdatethesetospecifythefullyqualifiedname.Ifnot,thereferencewillnotberenderedasalinkwhenthetopicisbuilt.

Warning:Unabletoresolvetopiclinkto'[file]'ThiswarningappearswhenthetargetfileofanHTMLanchorcouldnotbefoundinanyoftheconvertedtopics.Insuchcases,aToDoentryinthetopicreplacesthelinkandyouwillneedto

locatethefileandaddthelinkwhenreviewingthetopic.

Warning:Unknownentityencountered:[entity]Thiswarningappearsifanamedentityisencounteredthatisnotdefinedintheentityconversionrules.Insuchcases,theentityispassedthroughtotheconvertedtopicas-is.Whenyoubuildthetopic,itwillmostlikelyfailbecausethe.NETXMLparserwillnotrecognizeit.Theentitywillneedtobecorrectedorremoved.

ToDoItemsWhilereviewingtopicsafterconversion,youwillseevarious""comments.Thefollowingitemsdescribewhateachofthemmeans.

TODO:Addnamedanchor:[id]ThiscommentappearsintheplaceofanamedHTMLanchor.ThisisareminderthatyouwillneedtoapplytheindicatedIDasanaddressattributeontheappropriateMAMLelementlocatednearthecomment.RefertotheSandcastleMAMLGuideforinformationonwhichelementssupportanaddressattribute.

TODO:Missingsourceimage:[file]ThiscommentappearswhenanHTMLimagelinkisconvertedtoamediaLinkandthesourcefilecouldnotbefound.Whilethelinkwillstillbecreatedandanentrymadeinthemediacontentfile,thecorrespondingsourcefilewillnotbefoundinthemediafolderafterconversion.Youwillneedtomanuallylocatethefileandaddittotheproject.

TODO:MoveintroductiontexthereThisToDoitemwillbeseenintherequiredintroductionsectionthatisaddedtoeverytopic.Sincetheconversionprocesscannotguesswhattextyoumightwanttoappearthere,itleavesitforyoutohandleduringthereview.

TODO:ReferencenotfullyqualifiedThiscommentappearsnexttoacodeEntityReferenceinwhichthetargetisnotafullyqualifiedname.Youwillneedtoupdatethereferencetospecifythefullyqualifiedname.Ifnot,thereferencewillnotberenderedasalinkwhenthetopicisbuilt.

TODO:Reviewmarkup

ThiscommentprecedesanyHTMLelementswrappedintheMAMLmarkupelement.Thecontentoftheelementshouldbereviewedtoseeifitshouldberetained,removed,oreditedtouseotherappropriateMAMLelements.

TODO:Unknowntopiclink:[file]ThiscommentappearsinplaceofanHTMLanchorwhentheindicatedtargetfile/IDcouldnotbefoundinanyoftheconvertedtopics.Insuchcases,youwillneedtolocatethefileandaddthelinkwhenreviewingthetopic.

SeeAlsoOtherResourcesTheConversionProcessAdditionalOutputFiles


[email protected]



HTMLtoMAMLConverter

CommonIssuesandSolutionsThistopiccoverssomecommonissuesthatyouwillencounterwhenreviewingtopicsafterconversionalongwithtipsonsolvingthem.

MissingendelementsThesecanbefoundbyperformingabuildwithyourpreferreddocumentationtool.Theerrormessagewilllistthefailingtopicalongwiththeelementname(s)andthelinenumberandcolumnwherethestartingandendingelementsdidnotmatchup.Tofixtheissue,editthetopicandaddthemissingendelementinthecorrectlocation.

Ill-formedorunencodedentitiesHTMLisquiteforgivingwhenitcomestoill-formedorunencodedentitiesbutXMLisnot.Examplesincludemissingtheendingsemi-colon(&ltratherthan<)ornotencodingitatall(using&&inexamplecoderatherthan&&).Thesecanalsobefoundbydoingabuildandlocatingtheoffendingentityviatheinformationprovidedintheerrormessage.

TableheaderformattingislostWhenanHTMLtableisconvertedtoMAML,anythelementsareconvertedtotheequivalententryMAMLelement.Thisresultsintheheadercellbeingrenderedasanormalcellinthetable.Inordertorenderthecellsusingthetableheadingstyle,wrapthecontainingrowelementtoatableHeaderelement.Forexample:

<table>

<tableHeader>

<row>

<entry><para>Column1</para></entry>

<entry><para>Column2</para></entry>

</row>

</tableHeader>

<row>

<entry><para>Value1</para></entry>

Copy

ImagelinktypeandalignmentAsnotedintheContext-basedConversionstopic,youmayneedtochangemediaLinkelementstomediaLinkInlineelementswhereappropriate.Inaddition,youmayneedtoaddcaptionsand/orsetthealignmentattributesbasedonyourpreferences.

ParagraphspacingisinconsistentOmittingparaelementsaroundparagraphsorusingself-closingparaelementscancausesomeinconsistentspacingbetweenparagraphs.Tomakeitconsistent,wrapallparagraphsinopeningandclosingparaelements.

SeeAlsoOtherResourcesUsingtheConverterTheConversionProcess


[email protected]

<entry><para>Value2</para></entry>

</row>

<row>

<entry><para>ValueA</para></entry>

<entry><para>ValueB</para></entry>

</row>

</table>



HTMLtoMAMLConverter

LinkstoResourcesThistopicscontainslinkstovariousresourcesthatyoumayfinduseful.

LinkstoResourcesMicrosoft.NETFrameworksandSDKs.

ThelatestversionoftheSandcastleHelpFileBuilder(currentlythev2015.10.10.0releaseasofOctober10,2015).

TodiscusstheSandcastletoolsandextras,suggestnewfeatures,reportbugs,andrequesthelpusingthem,visittheSandcastleHelpFileBuilderprojectsite.

Fordiscussionandquestionsabouthelpsystemsingeneral,visittheVisualStudioGeneralQuestionsforum.

TheretiredMicrosoftDeveloperDocumentationandHelpSystemforummayalsoprovideinformationonolderhelpsystems.

MAMLInformationandGuidesForacomprehensivelistofMAMLdocumentationtagsandadescriptionoftheirattributesandusageseetheSandcastleMAMLGuidealsoincludedwiththehelpfilebuilder.

Forgeneralbackgroundinformation,seetheWikipediaentryMicrosoftAssistanceMarkupLanguageor,forschemainformation,seetheMAMLinformationathelp-info.de.


[email protected]

https://msdn.microsoft.com/en-us/vstudio/aa496123



http://social.msdn.microsoft.com/Forums/en-US/visualstudiogeneral/threads/

http://social.msdn.microsoft.com/forums/en-US/devdocs/threads/

https://EWSoftware.GitHub.io/MAMLGuide

http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language

http://www.help-info.de/en/Help_Info_AP_Help/longhorn_maml_example.htm



HTMLtoMAMLConverter

GlossaryA|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z

CconceptualbuildAbuildthatusesSandcastletoproducehelpfiletopicsusinginformationextractedfromconceptualcontenttopicsandtheirrelatedfiles.

SeeAlso:referencebuild,Sandcastle

conceptualcontentAtopicfilethatcontainsconceptualcontent.Thesecanbeusedtoaddusagenotes,walkthroughs,tutorials,etc.toahelpfile.

GGloballyUniqueIdentifier,GUIDAuniquevaluethatisassociatedwitheachconceptualtopicandimageinaproject.Wheninsertinglinkstotopicsorimages,theIDisusedtorefertothem.Thisallowsyoutoalterthenamesorlocationsofthetopicfileswithouthavingtochangethenameorlocationineachtopicthatreferencesthem.

MMAMLAnacronymthatstandsforMicrosoftAssistanceMarkupLanguage.ConceptualcontenttopicsarecomposedofMAMLelements.

mediacontentfile

ThisfilecontainsinformationabouttheimagesreferencedinmediaLinkandmediaLinkInlineelementsinconceptualcontent.

RreferencebuildAbuildthatusesSandcastletoproducehelpfiletopicsusinginformationextractedfrommanagedassembliesandtheirassociatedXMLcommentsfiles.

SeeAlso:conceptualbuild,Sandcastle

SSandcastleSandcastleisasetoftoolsoriginallyproducedbyMicrosoftthatcanbeusedtobuildhelpfilesfor.NETmanagedlibraries,conceptualcontent,oramixofboth.MicrosoftofficiallydiscontinueddevelopmentinOctober2012.TheSandcastletoolshavebeenmergedwiththeSandcastleHelpFileBuilderprojectandaredevelopedandsupportedtherenowaspartofthatproject.

SeeAlso:SandcastleHelpFileBuilder

SandcastleHelpFileBuilder,SHFBTheSandcastleHelpFileBuilderisastandalonetoolusedtoautomateSandcastle.ItconsistsofaGUIfrontendthathelpsyoumanageandbuildhelpfileprojects.ItusesastandardMSBuildformatprojectfilewhichcanalsobybuiltfromthecommandlineusingMSBuildorintegratedintoVisualStudiobuildsorotherbuildscriptstoproduceahelpfilewhenyourapplicationprojectsarebuilt.Inaddition,itprovidesasetofadditionalfeaturesbeyondthosesuppliedwithSandcastlethatcanimproveyourhelpfileandmakeiteasiertodeploy.

SeeAlso:Sandcastle

Ttoken,tokenfile



Atokenisusedasareplaceabletagwithinatopicandisrepresentedusingatokenelement.Theinnertextoftheelementisatokenname.Thetokensaredefinedinaseparatetokenfile.Theyareaneasywaytorepresentcommonitemsthatyouuseregularlysuchasacommonphraseorexternallink.


[email protected]



HTMLtoMAMLConverter

VersionHistoryThetopicsinthissectiondescribethevariouschangesmadetotheHTMLtoMAMLConverteroverthelifeoftheproject.

VersionHistorySelectaversionbelowtoseeadescriptionofitschanges.

Version1.0.0.1

Version1.0.0.0


[email protected]



HTMLtoMAMLConverter

Version1.0.0.1Version1.0.0.1wasreleasedonJuly26th,2010.

ChangesinThisReleaseFixedabugthatcausedacrashwhenaJavaScriptreferencewasencounteredinananchortag'sHREFattribute.Suchreferencesarenowignoredandawarningiswrittentothetopicandthelogfileinstead.

SeeAlsoOtherResourcesVersionHistory


[email protected]



HTMLtoMAMLConverter

Version1.0.0.0Version1.0.0.0wasreleasedonOctober25th,2008.

ChangesinThisReleaseInitialrelease.

SeeAlsoOtherResourcesVersionHistory


[email protected]



HTMLtoMAMLConverter

HtmlToMamlConversionNamespaceThisnamespacecontainstheclassesusedtoconvertHTMLfilestoMAMLtopicfiles.

Classes Class Description

ConversionProgressEventArgs ThisisacustomeventargumentsclassfortheConversionProgressevent.

ConvertHtmlToMaml ThisutilityisusedtoconvertHTMLfilestoMAMLtopicsandcreatesomesupportingfiles.

FileParser ThisisusedtoparseanHTMLfiletoextractthevariouspartsforconversiontoMAML

HtmlToMaml ThisclassisusedtoconvertasetofHTMLfiletotheircloseequivalentasconceptualMAML

topicfiles.

ImageReference Thisrepresentsanimagereference

ImageReferenceCollection Thisisacollectionofimagereferences

TagOptions ThisisusedtocontaintheoptionsandstateforaTagentryfromtheconversionrulesfile.

Topic Thisrepresentsatopicfile

TopicCollection Thisisacollectionoftopicitems


[email protected]



HTMLtoMAMLConverter

ConversionProgressEventArgsClassThisisacustomeventargumentsclassfortheConversionProgressevent.

InheritanceHierarchySystemObjectSystemEventArgsHtmlToMamlConversionConversionProgressEventArgs

Namespace:HtmlToMamlConversionAssembly:ConvertHtmlToMaml(inConvertHtmlToMaml.exe)Version:1.0.0.2

Syntax

TheConversionProgressEventArgstypeexposesthefollowingmembers.

Constructors Name Description

ConversionProgressEventArgs Constructor

Top

Properties

publicclassConversionProgressEventArgs:EventArgs

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/e5kfa45b

http://msdn2.microsoft.com/en-us/library/118wxtk3

Name Description

Message Getthemessageassociatedwiththeprogressreport

Top

Methods Name Description

Equals Determineswhetherthespecifiedobjectisequaltothecurrentobject.(InheritedfromObject.)

Finalize Allowsanobjecttotrytofreeresourcesandperformothercleanupoperationsbeforeitisreclaimedbygarbagecollection.(InheritedfromObject.)

GetHashCode Servesasthedefaulthashfunction.(InheritedfromObject.)

GetType GetstheTypeofthecurrentinstance.(InheritedfromObject.)

MemberwiseClone CreatesashallowcopyofthecurrentObject.(InheritedfromObject.)

ToString Returnsastringthatrepresentsthecurrentobject.(InheritedfromObject.)

http://msdn2.microsoft.com/en-us/library/bsc2ak47


http://msdn2.microsoft.com/en-us/library/4k87zsw7


http://msdn2.microsoft.com/en-us/library/zdee4b3y


http://msdn2.microsoft.com/en-us/library/dfwy45w9

http://msdn2.microsoft.com/en-us/library/42892f65


http://msdn2.microsoft.com/en-us/library/57ctke0a



http://msdn2.microsoft.com/en-us/library/7bxwbwt2


Top

SeeAlsoReferenceHtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

ConversionProgressEventArgsConstructorConstructor


Syntax

Parameters

progressMessageType:SystemStringTheprogressmessage

SeeAlsoReferenceConversionProgressEventArgsClassHtmlToMamlConversionNamespace


[email protected]

publicConversionProgressEventArgs(

stringprogressMessage

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/s1wwdcbf



HTMLtoMAMLConverter

ConversionProgressEventArgsPropertiesTheConversionProgressEventArgstypeexposesthefollowingmembers.

Properties Name Description

Message Getthemessageassociatedwiththeprogressreport

Top



[email protected]



HTMLtoMAMLConverter

ConversionProgressEventArgsMessagePropertyGetthemessageassociatedwiththeprogressreport


Syntax

PropertyValueType:String



[email protected]

publicstringMessage{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

ConversionProgressEventArgsMethodsTheConversionProgressEventArgstypeexposesthefollowingmembers.




















Top



[email protected]





HTMLtoMAMLConverter

ConvertHtmlToMamlClassThisutilityisusedtoconvertHTMLfilestoMAMLtopicsandcreatesomesupportingfiles.

InheritanceHierarchySystemObjectHtmlToMamlConversionConvertHtmlToMaml


Syntax

TheConvertHtmlToMamltypeexposesthefollowingmembers.


Main Mainprogramentrypoint

Top



publicstaticclassConvertHtmlToMaml

CopyC# VB C++ F#



[email protected]


HTMLtoMAMLConverter

ConvertHtmlToMamlMethodsTheConvertHtmlToMamltypeexposesthefollowingmembers.


Main Mainprogramentrypoint

Top

SeeAlsoReferenceConvertHtmlToMamlClassHtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

ConvertHtmlToMamlMainMethodMainprogramentrypoint


Syntax

Parameters

argsType:SystemStringThecommandlinearguments(thesourcefolder,thedestinationfolder,andtheoptional"/companion"optiontocreatecompanionfilesforeachtopicfile).

ReturnValueType:Int32Zeroonsuccess,non-zeroonfailure

SeeAlsoReferenceConvertHtmlToMamlClassHtmlToMamlConversionNamespace

publicstaticintMain(

string[]args

)

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/td2s409d


[email protected]



HTMLtoMAMLConverter

FileParserClassThisisusedtoparseanHTMLfiletoextractthevariouspartsforconversiontoMAML

InheritanceHierarchySystemObjectHtmlToMamlConversionFileParser


Syntax

TheFileParsertypeexposesthefollowingmembers.


FileParser InitializesanewinstanceoftheFileParserclass

Top


Body ThisreturnstheHTML

publicclassFileParser

CopyC# VB C++ F#


bodyparsedfromthefile

BodyExtractExpression Thisisusedtogetorsetthebodyextractregularexpression

HelpAttributes Thisreturnsthehelpattributesparsedfromthefile

HelpKeywords Thisreturnsthehelpkeywordsparsedfromthefile

IsDefaultTopic Thisreturnsthedefaulttopicflagiffoundinthetopic

RevisionNumber Thisreturnstherevisionnumberparsedfromthefile

SortOrder Thisreturnsthesortordervalueiffoundinthetopic

SplitToc ThisreturnsthesplitTOCflagiffoundinthetopic

Title Thisreturnsthetitleparsedfromthefile

TocExclude ThisreturnstheTOCexcludeflagiffoundinthetopic

TopicAbstract Thisreturnstheabstract

parsedfromthefile

TopicId ThisreturnsthetopicIDparsedfromthefile

Top







ParseFile ParsethespecifiedHTMLfile













ReadWithEncoding Thisisusedtoreadinafileusinganappropriateencodingmethod


Top



[email protected]





HTMLtoMAMLConverter

FileParserConstructorInitializesanewinstanceoftheFileParserclass


Syntax

SeeAlsoReferenceFileParserClassHtmlToMamlConversionNamespace


[email protected]

publicFileParser()

CopyC# VB C++ F#



HTMLtoMAMLConverter

FileParserPropertiesTheFileParsertypeexposesthefollowingmembers.


Body ThisreturnstheHTMLbodyparsedfromthefile

BodyExtractExpression Thisisusedtogetorsetthebodyextractregularexpression

HelpAttributes Thisreturnsthehelpattributesparsedfromthefile

HelpKeywords Thisreturnsthehelpkeywordsparsedfromthefile


RevisionNumber Thisreturnstherevisionnumberparsedfromthefile



Title Thisreturnsthetitleparsedfromthefile


TopicAbstract Thisreturnstheabstractparsedfromthefile

TopicId ThisreturnsthetopicIDparsedfromthefile

Top



[email protected]



HTMLtoMAMLConverter

FileParserBodyPropertyThisreturnstheHTMLbodyparsedfromthefile


Syntax




[email protected]

publicstringBody{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserBodyExtractExpressionPropertyThisisusedtogetorsetthebodyextractregularexpression


Syntax


ExceptionsException Condition

InvalidOperationException Thisisthrowniftheregularexpressionisnullorempty.



publicstaticstringBodyExtractExpression{get;set

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/2asft85a


[email protected]


HTMLtoMAMLConverter

FileParserHelpAttributesPropertyThisreturnsthehelpattributesparsedfromthefile


Syntax

PropertyValueType:MSHelpAttrCollection



[email protected]

publicMSHelpAttrCollectionHelpAttributes{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

FileParserHelpKeywordsPropertyThisreturnsthehelpkeywordsparsedfromthefile


Syntax

PropertyValueType:MSHelpKeywordCollection



[email protected]

publicMSHelpKeywordCollectionHelpKeywords{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

FileParserIsDefaultTopicPropertyThisreturnsthedefaulttopicflagiffoundinthetopic


Syntax

PropertyValueType:Boolean



[email protected]

publicboolIsDefaultTopic{get;}

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/a28wyd50



HTMLtoMAMLConverter

FileParserRevisionNumberPropertyThisreturnstherevisionnumberparsedfromthefile


Syntax




[email protected]

publicstringRevisionNumber{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserSortOrderPropertyThisreturnsthesortordervalueiffoundinthetopic


Syntax

PropertyValueType:Int32



[email protected]

publicintSortOrder{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserSplitTocPropertyThisreturnsthesplitTOCflagiffoundinthetopic


Syntax




[email protected]

publicboolSplitToc{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserTitlePropertyThisreturnsthetitleparsedfromthefile


Syntax




[email protected]

publicstringTitle{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserTocExcludePropertyThisreturnstheTOCexcludeflagiffoundinthetopic


Syntax




[email protected]

publicboolTocExclude{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserTopicAbstractPropertyThisreturnstheabstractparsedfromthefile


Syntax




[email protected]

publicstringTopicAbstract{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FileParserTopicIdPropertyThisreturnsthetopicIDparsedfromthefile


Syntax

PropertyValueType:Guid



[email protected]

publicGuidTopicId{get;}

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/cey1zx63



HTMLtoMAMLConverter

FileParserMethodsTheFileParsertypeexposesthefollowingmembers.







ParseFile ParsethespecifiedHTMLfile













ReadWithEncoding Thisisusedtoreadinafileusinganappropriateencodingmethod


Top



[email protected]





HTMLtoMAMLConverter

FileParserParseFileMethodParsethespecifiedHTMLfile


Syntax

Parameters

filenameType:SystemStringThefiletoparse

RemarksAfterparsing,thepropertiescanbeusedtoretrievetheinformationparsedfromthefile.



publicvoidParseFile(

stringfilename

)

CopyC# VB C++ F#



[email protected]


HTMLtoMAMLConverter

FileParserReadWithEncodingMethodThisisusedtoreadinafileusinganappropriateencodingmethod


Syntax

Parameters

filenameType:SystemStringThefiletoload

encodingType:System.TextEncodingPassthedefaultencodingtouse.Onreturn,itcontainstheactualencodingforthefile.

ReturnValueType:StringThecontentsofthefile.

Remarks

publicstaticstringReadWithEncoding(

stringfilename,

refEncodingencoding

)

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/86hf4sb8


Whenreadingthefile,usethedefaultencodingspecifiedbutdetecttheencodingifbyteordermarksarepresent.Inaddition,ifthetemplateisanXMLfileanditcontainsanencodingidentifierintheXMLtag,thefileisreadusingthatencoding.



[email protected]



HTMLtoMAMLConverter

HtmlToMamlClassThisclassisusedtoconvertasetofHTMLfiletotheircloseequivalentasconceptualMAMLtopicfiles.

InheritanceHierarchySystemObjectHtmlToMamlConversionHtmlToMaml


Syntax

TheHtmlToMamltypeexposesthefollowingmembers.


HtmlToMaml Constructor

Top


BasePath Thisreturnsthesourcepathforuseasthebasepath

publicclassHtmlToMaml:IBasePathProvider

CopyC# VB C++ F#


PathProvider Thisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.

Top


ConvertTopic Thisiscalledtoconvertasingletopicanditschildren

ConvertTopics Thisiscalledtoperformtheactualconversion

CreateCompanionFile Createacompanionfileforatopic












OnConversionProgress ThisraisestheConversionProgressevent.

ReportProgress Thisisusedtoreportprogressduringtheconversion


Top

Events Name Description

ConversionProgress Thiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.

Top

SeeAlsoReference









HtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

HtmlToMamlConstructorConstructor


Syntax

Parameters

sourceType:SystemStringThesourcepathcontainingtheHTMLfiles

destType:SystemStringThedestinationpathfortheMAMLtopicsandsupportingfiles

createCompanionType:SystemBooleanTruetocreatecompanionfilesforalltopicfilesorfalsetonotcreatethem.

moveIntroTextType:SystemBooleanIftrue,movetextbeforethefirstsectionintoanintroductionelement.Iffalse,insertaplaceholderintroductionelement.

publicHtmlToMaml(

stringsource,

stringdest,

boolcreateCompanion,

boolmoveIntroText

)

CopyC# VB C++ F#





SeeAlsoReferenceHtmlToMamlClassHtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

HtmlToMamlPropertiesTheHtmlToMamltypeexposesthefollowingmembers.


BasePath Thisreturnsthesourcepathforuseasthebasepath

PathProvider Thisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.

Top



[email protected]



HTMLtoMAMLConverter

HtmlToMamlBasePathPropertyThisreturnsthesourcepathforuseasthebasepath


Syntax

PropertyValueType:StringImplementsIBasePathProviderBasePath



[email protected]

publicstringBasePath{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

HtmlToMamlPathProviderPropertyThisreturnsthebasepathproviderfortheotherclassesinvolvedintheconversionthatneedrelativepaths.


Syntax

ReturnValueType:IBasePathProviderTheHtmlToMamlobjectperformingtheconversion.



[email protected]

publicstaticIBasePathProviderPathProvider{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

HtmlToMamlMethodsTheHtmlToMamltypeexposesthefollowingmembers.


ConvertTopic Thisiscalledtoconvertasingletopicanditschildren

ConvertTopics Thisiscalledtoperformtheactualconversion

CreateCompanionFile Createacompanionfileforatopic












OnConversionProgress ThisraisestheConversionProgressevent.

ReportProgress Thisisusedtoreportprogressduringtheconversion


Top



[email protected]











HTMLtoMAMLConverter

HtmlToMamlConvertTopicMethodThisiscalledtoconvertasingletopicanditschildren


Syntax

Parameters

topicType:HtmlToMamlConversionTopicThetopictoconvert



[email protected]

publicvoidConvertTopic(

Topictopic

)

CopyC# VB C++ F#



HTMLtoMAMLConverter

HtmlToMamlConvertTopicsMethodThisiscalledtoperformtheactualconversion


Syntax



[email protected]

publicvoidConvertTopics()

CopyC# VB C++ F#



HTMLtoMAMLConverter

HtmlToMamlCreateCompanionFileMethodCreateacompanionfileforatopic


Syntax

Parameters

filenameType:SystemStringThecompanionfilename.

topicType:HtmlToMamlConversionTopicThetopic



publicstaticvoidCreateCompanionFile(

stringfilename,

Topictopic

)

CopyC# VB C++ F#



[email protected]


HTMLtoMAMLConverter

HtmlToMamlOnConversionProgressMethodThisraisestheConversionProgressevent.


Syntax

Parameters

eType:HtmlToMamlConversionConversionProgressEventArgsTheeventarguments



[email protected]

protectedvirtualvoidOnConversionProgress(

ConversionProgressEventArgse

)

CopyC# VB C++ F#



HTMLtoMAMLConverter

HtmlToMamlReportProgressMethodThisisusedtoreportprogressduringtheconversion


Syntax

Parameters

messageType:SystemStringThemessagetoreport

argsType:SystemObjectAlistofargumentstoformatintothemessagetext



protectedvoidReportProgress(

stringmessage,

paramsObject[]args

)

CopyC# VB C++ F#




[email protected]


HTMLtoMAMLConverter

HtmlToMamlEventsTheHtmlToMamltypeexposesthefollowingmembers.


ConversionProgress Thiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.

Top



[email protected]



HTMLtoMAMLConverter

HtmlToMamlConversionProgressEventThiseventisraisedtoreportprogressinformationthroughouttheconversionprocess.


Syntax

ValueType:SystemEventHandlerConversionProgressEventArgs



[email protected]

publiceventEventHandler<ConversionProgressEventArgs

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/db0etb8x



HTMLtoMAMLConverter

ImageReferenceClassThisrepresentsanimagereference

InheritanceHierarchySystemObjectHtmlToMamlConversionImageReference


Syntax

TheImageReferencetypeexposesthefollowingmembers.


ImageReference Constructor

Top


AlternateText Getorsettheimage'salternatetext

publicclassImageReference

CopyC# VB C++ F#


Id Thisreturnstheimage'suniqueID

SourceFile Thisisusedtogetthesourceimagefilename

Top







ToString Converttostringfordebuggingpurposes(OverridesObjectToString.)














Top



[email protected]



HTMLtoMAMLConverter

ImageReferenceConstructorConstructor


Syntax

Parameters

sourceType:SystemStringThesourceimagefile

SeeAlsoReferenceImageReferenceClassHtmlToMamlConversionNamespace


[email protected]

publicImageReference(

stringsource

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

ImageReferencePropertiesTheImageReferencetypeexposesthefollowingmembers.


AlternateText Getorsettheimage'salternatetext

Id Thisreturnstheimage'suniqueID

SourceFile Thisisusedtogetthesourceimagefilename

Top



[email protected]



HTMLtoMAMLConverter

ImageReferenceAlternateTextPropertyGetorsettheimage'salternatetext


Syntax




[email protected]

publicstringAlternateText{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

ImageReferenceIdPropertyThisreturnstheimage'suniqueID


Syntax




[email protected]

publicstringId{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

ImageReferenceSourceFilePropertyThisisusedtogetthesourceimagefilename


Syntax

PropertyValueType:FilePath



[email protected]

publicFilePathSourceFile{get;set;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

ImageReferenceMethodsTheImageReferencetypeexposesthefollowingmembers.





















Top



[email protected]



HTMLtoMAMLConverter

ImageReferenceToStringMethodConverttostringfordebuggingpurposes


Syntax

ReturnValueType:StringThestringrepresentationofthetopic



[email protected]

publicoverridestringToString()

CopyC# VB C++ F#




HTMLtoMAMLConverter

ImageReferenceCollectionClassThisisacollectionofimagereferences

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionImageReferenceHtmlToMamlConversionImageReferenceCollection


Syntax

TheImageReferenceCollectiontypeexposesthefollowingmembers.


ImageReferenceCollection InitializesanewinstanceoftheImageReferenceCollectionclass

Top

Properties

publicclassImageReferenceCollection:Collection<

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/ms132397

Name Description

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionImageReference.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionImageReference.)

Top


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionImageReference.)

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)







http://msdn2.microsoft.com/en-us/library/5y536ey6












Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionImageReference.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionImageReference.)



GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionImageReference.)








http://msdn2.microsoft.com/en-us/library/czz5hkty














IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionImageReference.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)


Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionImageReference.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)



















RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

Save Writetheimagereferencecollectiontoamediacontentfile.

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)


Top



[email protected]










HTMLtoMAMLConverter

ImageReferenceCollectionConstructorInitializesanewinstanceoftheImageReferenceCollectionclass


Syntax

SeeAlsoReferenceImageReferenceCollectionClassHtmlToMamlConversionNamespace


[email protected]

publicImageReferenceCollection()

CopyC# VB C++ F#



HTMLtoMAMLConverter

ImageReferenceCollectionPropertiesTheImageReferenceCollectiontypeexposesthefollowingmembers.


Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionImageReference.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionImageReference.)

Top













[email protected]


HTMLtoMAMLConverter

ImageReferenceCollectionMethodsTheImageReferenceCollectiontypeexposesthefollowingmembers.


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionImageReference.)

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionImageReference.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionImageReference.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthe
















targetarray.(InheritedfromCollectionImageReference.)



GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionImageReference.)



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionImageReference.)

















Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionImageReference.)


Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionImageReference.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionImageReference.)

Save Writetheimagereferencecollectiontoamediacontentfile.



















SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionImageReference.)


Top



[email protected]







HTMLtoMAMLConverter

ImageReferenceCollectionSaveMethodWritetheimagereferencecollectiontoamediacontentfile.


Syntax

Parameters

filenameType:SystemStringThefiletowhichtheimagereferencecollectionissaved.



[email protected]

publicvoidSave(

stringfilename

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

TagOptionsClassThisisusedtocontaintheoptionsandstateforaTagentryfromtheconversionrulesfile.

InheritanceHierarchySystemObjectHtmlToMamlConversionTagOptions


Syntax

TheTagOptionstypeexposesthefollowingmembers.


TagOptions Constructor

Top


Attributes Thisreturnstheattributestousebasedonthelastevaluation

publicclassTagOptions

CopyC# VB C++ F#


Closing Thisreturnstheclosing"/"iftheelementisanendtag

Tag Thisreturnsthereplacementtagtousebasedonthelastevaluation.

Top



Evaluate Evaluatethematchanddeterminethepropertiestouseforthereplacement.




MemberwiseClone CreatesashallowcopyofthecurrentObject.












(InheritedfromObject.)


Top



[email protected]






HTMLtoMAMLConverter

TagOptionsConstructorConstructor


Syntax

Parameters

tagType:System.Xml.XPathXPathNavigatorThetagnode

SeeAlsoReferenceTagOptionsClassHtmlToMamlConversionNamespace


[email protected]

publicTagOptions(

XPathNavigatortag

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/9x81sf5a



HTMLtoMAMLConverter

TagOptionsPropertiesTheTagOptionstypeexposesthefollowingmembers.


Attributes Thisreturnstheattributestousebasedonthelastevaluation

Closing Thisreturnstheclosing"/"iftheelementisanendtag

Tag Thisreturnsthereplacementtagtousebasedonthelastevaluation.

Top



[email protected]



HTMLtoMAMLConverter

TagOptionsAttributesPropertyThisreturnstheattributestousebasedonthelastevaluation


Syntax




[email protected]

publicstringAttributes{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TagOptionsClosingPropertyThisreturnstheclosing"/"iftheelementisanendtag


Syntax




[email protected]

publicstringClosing{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TagOptionsTagPropertyThisreturnsthereplacementtagtousebasedonthelastevaluation.


Syntax




[email protected]

publicstringTag{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TagOptionsMethodsTheTagOptionstypeexposesthefollowingmembers.



Evaluate Evaluatethematchanddeterminethepropertiestouseforthereplacement.


















Top



[email protected]





HTMLtoMAMLConverter

TagOptionsEvaluateMethodEvaluatethematchanddeterminethepropertiestouseforthereplacement.


Syntax

Parameters

matchType:System.Text.RegularExpressionsMatchTheregularexpressionmatchtoevaluate



[email protected]

publicvoidEvaluate(

Matchmatch

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/20cdsf18



HTMLtoMAMLConverter

TopicClassThisrepresentsatopicfile

InheritanceHierarchySystemObjectHtmlToMamlConversionTopic


Syntax

TheTopictypeexposesthefollowingmembers.


Topic Constructor

Top


Body Getorsetthetopic'sbody

HelpAttributes Getthehelpattributes

publicclassTopic

CopyC# VB C++ F#


collection

HelpKeywords Getthehelpkeywordscollection

Id Thisreturnsthetopic'suniqueID


RevisionNumber Getorsetthetopic'srevisionnumber


SourceFile ThisisusedtogetthesourceHTMLfilename


Subtopics Thisisusedtogetthecollectionofsub-topics,ifany

Title Getorsetthetopic'stitle


TopicAbstract Getorsetthetopic'sabstract

Top







ParseFile Parsethetopicanditssub-topicfilestoextracttheinformationforconversion


Top
















[email protected]



HTMLtoMAMLConverter

TopicConstructorConstructor


Syntax

Parameters

sourceType:SystemStringThesourcefileornulltocreateanemptycontainernodewithnoassociatedtopic

SeeAlsoReferenceTopicClassHtmlToMamlConversionNamespace


[email protected]

publicTopic(

stringsource

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicPropertiesTheTopictypeexposesthefollowingmembers.


Body Getorsetthetopic'sbody

HelpAttributes Getthehelpattributescollection

HelpKeywords Getthehelpkeywordscollection

Id Thisreturnsthetopic'suniqueID


RevisionNumber Getorsetthetopic'srevisionnumber


SourceFile ThisisusedtogetthesourceHTMLfilename


Subtopics Thisisusedtogetthe

collectionofsub-topics,ifany

Title Getorsetthetopic'stitle


TopicAbstract Getorsetthetopic'sabstract

Top



[email protected]



HTMLtoMAMLConverter

TopicBodyPropertyGetorsetthetopic'sbody


Syntax




[email protected]

publicstringBody{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicHelpAttributesPropertyGetthehelpattributescollection


Syntax

PropertyValueType:MSHelpAttrCollectionIfnullorempty,therearenoattributes



[email protected]

publicMSHelpAttrCollectionHelpAttributes{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicHelpKeywordsPropertyGetthehelpkeywordscollection


Syntax

PropertyValueType:MSHelpKeywordCollectionIfnullorempty,therearenokeywords



[email protected]

publicMSHelpKeywordCollectionHelpKeywords{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicIdPropertyThisreturnsthetopic'suniqueID


Syntax

PropertyValueType:Guid



[email protected]

publicGuidId{get;set;}

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/cey1zx63



HTMLtoMAMLConverter

TopicIsDefaultTopicPropertyThisreturnsthedefaulttopicflagiffoundinthetopic


Syntax




[email protected]

publicboolIsDefaultTopic{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicRevisionNumberPropertyGetorsetthetopic'srevisionnumber


Syntax




[email protected]

publicstringRevisionNumber{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicSortOrderPropertyThisreturnsthesortordervalueiffoundinthetopic


Syntax

PropertyValueType:Int32



[email protected]

publicintSortOrder{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicSourceFilePropertyThisisusedtogetthesourceHTMLfilename


Syntax

PropertyValueType:FilePathIfsettonull,theitemwillrepresentacontainernodewithnoassociatedtopic.



[email protected]

publicFilePathSourceFile{get;set;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicSplitTocPropertyThisreturnsthesplitTOCflagiffoundinthetopic


Syntax




[email protected]

publicboolSplitToc{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicSubtopicsPropertyThisisusedtogetthecollectionofsub-topics,ifany


Syntax

PropertyValueType:TopicCollection



[email protected]

publicTopicCollectionSubtopics{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicTitlePropertyGetorsetthetopic'stitle


Syntax




[email protected]

publicstringTitle{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicTocExcludePropertyThisreturnstheTOCexcludeflagiffoundinthetopic


Syntax




[email protected]

publicboolTocExclude{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicTopicAbstractPropertyGetorsetthetopic'sabstract


Syntax




[email protected]

publicstringTopicAbstract{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicMethodsTheTopictypeexposesthefollowingmembers.







ParseFile Parsethetopicanditssub-topicfilestoextracttheinformationforconversion














Top



[email protected]




HTMLtoMAMLConverter

TopicParseFileMethodParsethetopicanditssub-topicfilestoextracttheinformationforconversion


Syntax

Parameters

fileParserType:HtmlToMamlConversionFileParserThefileparser

imageDictionaryType:System.Collections.GenericDictionaryFilePath,ImageReferenceTheimagedictionary


publicvoidParseFile(

FileParserfileParser,

Dictionary<FilePath,ImageReference>imageDictionary

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/xfhwa508


[email protected]



HTMLtoMAMLConverter

TopicToStringMethodConverttostringfordebuggingpurposes


Syntax

ReturnValueType:StringThestringrepresentationofthetopic



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicCollectionClassThisisacollectionoftopicitems

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionTopicHtmlToMamlConversionTopicCollection


Syntax

TheTopicCollectiontypeexposesthefollowingmembers.


TopicCollection InitializesanewinstanceoftheTopicCollectionclass

Top


Count Getsthenumberofelements

publicclassTopicCollection:Collection<Topic>

CopyC# VB C++ F#




actuallycontainedintheCollectionT.(InheritedfromCollectionTopic.)

DefaultTopic Thisisusedtogetthedefaulttopic

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionTopic.)

SplitTocAtTopic ThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.

Top


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionTopic.)

AddTopicsFromFolder Addalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.

Clear RemovesallelementsfromtheCollectionT.(Inheritedfrom














CollectionTopic.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionTopic.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionTopic.)



GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.


















(InheritedfromCollectionTopic.)



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionTopic.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)


ParseFiles Parseallfilesinthecollectiontoextractthe



















informationforconversion.

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionTopic.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

Save Savethetopiccollectiontothenamedcontentlayoutfile

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Sort Thisisusedtosortthecollection















Top



[email protected]



HTMLtoMAMLConverter

TopicCollectionConstructorInitializesanewinstanceoftheTopicCollectionclass


Syntax

SeeAlsoReferenceTopicCollectionClassHtmlToMamlConversionNamespace


[email protected]

publicTopicCollection()

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicCollectionPropertiesTheTopicCollectiontypeexposesthefollowingmembers.


Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionTopic.)

DefaultTopic Thisisusedtogetthedefaulttopic

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionTopic.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionTopic.)

SplitTocAtTopic ThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.

Top

SeeAlsoReferenceTopicCollectionClass










HtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

TopicCollectionDefaultTopicPropertyThisisusedtogetthedefaulttopic


Syntax

PropertyValueType:TopicItreturnsthedefaulttopicornullifoneisnotset



[email protected]

publicTopicDefaultTopic{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicCollectionSplitTocAtTopicPropertyThisisusedtogetthetopicatwhichthetableofcontentissplitbytheAPIcontent.


Syntax

PropertyValueType:TopicThiswillonlybevalidifitreferstoarootleveltopic.Itwillreturnnullifasplitlocationhasnotbeensetattherootlevel.



[email protected]

publicTopicSplitTocAtTopic{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

TopicCollectionMethodsTheTopicCollectiontypeexposesthefollowingmembers.


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionTopic.)

AddTopicsFromFolder Addalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.

Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

ClearItems RemovesallelementsfromtheCollectionT.(InheritedfromCollectionTopic.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionTopic.)

CopyTo Copiestheentire














CollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionTopic.)



GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionTopic.)



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthe

















firstoccurrencewithintheentireCollectionT.(InheritedfromCollectionTopic.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)

InsertItem InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionTopic.)


ParseFiles Parseallfilesinthecollectiontoextracttheinformationforconversion.

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionTopic.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)


















RemoveItem RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionTopic.)

Save Savethetopiccollectiontothenamedcontentlayoutfile

SetItem Replacestheelementatthespecifiedindex.(InheritedfromCollectionTopic.)



Top



[email protected]










HTMLtoMAMLConverter

TopicCollectionAddTopicsFromFolderMethodAddalltopicsfromthespecifiedfolderrecursivelytothetopiccollection.


Syntax

Parameters

folderType:SystemStringThefolderfromwhichtogetthefiles

topicDictionaryType:System.Collections.GenericDictionaryFilePath,TopicAdictionaryusedtocontainthelistoffilesindexbyname.

RemarksOnlyfileswitha.htm?or.topicextensionareadded

SeeAlso

publicvoidAddTopicsFromFolder(

stringfolder,

Dictionary<FilePath,Topic>topicDictionary

)

CopyC# VB C++ F#



ReferenceTopicCollectionClassHtmlToMamlConversionNamespace


[email protected]



HTMLtoMAMLConverter

TopicCollectionParseFilesMethodParseallfilesinthecollectiontoextracttheinformationforconversion.


Syntax

Parameters

fileParserType:HtmlToMamlConversionFileParserThefileparser

imageDictionaryType:System.Collections.GenericDictionaryFilePath,ImageReferenceTheimagedictionary


publicvoidParseFiles(

FileParserfileParser,

Dictionary<FilePath,ImageReference>imageDictionary

)

CopyC# VB C++ F#



[email protected]



HTMLtoMAMLConverter

TopicCollectionSaveMethodSavethetopiccollectiontothenamedcontentlayoutfile


Syntax

Parameters

filenameType:SystemStringThefilenametowhichthecontentlayoutissaved.



[email protected]

publicvoidSave(

stringfilename

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

TopicCollectionSortMethodThisisusedtosortthecollection


Syntax

RemarksValuesaresortedbydisplaytitle.Comparisonsarecase-sensitive.



[email protected]

publicvoidSort()

CopyC# VB C++ F#



HTMLtoMAMLConverter

SandcastleBuilder.UtilsNamespaceThisnamespacecontainsclassesfromtheSandcastleHelpFileBuilderutilitieslibraryusedintheHTMLtoMAMLconverter.

Classes Class Description

FilePath Thisclassisusedtorepresentafilepath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

FolderPath Thisclassisusedtorepresentafolderpath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

MSHelpAttr ThisrepresentsanHTMLHelp2.xattributethatcanbe

addedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

MSHelpAttrCollection Thiscollectionclassisusedtoholdthehelpattributeitemsforaproject.

MSHelpKeyword ThisrepresentsanHTMLHelp2.xindexkeywordthatcanbeaddedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

MSHelpKeywordCollection Thiscollectionclassisusedtoholdthehelpindexkeyworditemsforaproject.

Interfaces Interface Description

IBasePathProvider ThisinterfacedefinesthepropertiesusedtoobtainabasepathforaFilePathobject.


[email protected]



HTMLtoMAMLConverter

FilePathClassThisclassisusedtorepresentafilepath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsFilePathSandcastleBuilder.UtilsFolderPath

Namespace:SandcastleBuilder.UtilsAssembly:ConvertHtmlToMaml(inConvertHtmlToMaml.exe)Version:1.0.0.2

Syntax

TheFilePathtypeexposesthefollowingmembers.


FilePath(IBasePathProvider) Defaultconstructor.Thefilepathisundefined.

FilePath(String,IBasePathProvider)

Constructor.Assignthespecifiedpath.

[SerializableAttribute]

publicclassFilePath:ICloneable

CopyC# VB C++ F#


FilePath(String,Boolean,IBasePathProvider)

Constructor.Assignthespecifiedpathandfixedsetting.

Top


BasePath Thisreturnsthebasepathfortheobject

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.

IsFixedPath ThisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathePersistablePathproperty.

Path Thisisusedtogetorsetthepathtouse.

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitablefor

persistingtostoragebasedonthecurrentsettings.

Top


AbsoluteToRelativePath Thishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.

Clone Thisreturnsacloneoftheobject

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(OverridesObjectEquals(Object).)


GetFullPath Thisreturnsthefullyqualifiedpathforthespecifiedpath.Thisversionallowswildcardsinthefilenamepartifpresent.




GetHashCode Getahashcodeforthefilepathobject(OverridesObjectGetHashCode.)



OnPersistablePathChanged ThisraisesthePersistablePathChangedevent

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent

RelativeToAbsolutePath Thishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.

ToString Convertthefilepathtoastring(OverridesObjectToString.)

Top










PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged

Top

Operators Name Description

Equality Overloadforequaloperator.

(FilePathtoString)

ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring

Inequality Overloadfornotequaloperator.

Top

SeeAlsoReferenceSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FilePathConstructorTherearethreeoverloadsfortheconstructor.

OverloadList Name Description

FilePath(IBasePathProvider) Defaultconstructor.Thefilepathisundefined.

FilePath(String,IBasePathProvider)


FilePath(String,Boolean,IBasePathProvider)


Top

SeeAlsoReferenceFilePathClassSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FilePathConstructor(IBasePathProvider)Defaultconstructor.Thefilepathisundefined.


Syntax

Parameters

providerType:SandcastleBuilder.UtilsIBasePathProviderThebasepathprovider

SeeAlsoReferenceFilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace


[email protected]

publicFilePath(

IBasePathProviderprovider

)

CopyC# VB C++ F#



HTMLtoMAMLConverter

FilePathConstructor(String,IBasePathProvider)Constructor.Assignthespecifiedpath.


Syntax

Parameters

pathType:SystemStringArelativeorabsolutepath.


RemarksUnlessIsFixedPathissettotrue,thepathisalwaystreatedasarelativepath.

SeeAlso

publicFilePath(

stringpath,


)

CopyC# VB C++ F#


ReferenceFilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FilePathConstructor(String,Boolean,IBasePathProvider)Constructor.Assignthespecifiedpathandfixedsetting.


Syntax

Parameters


isFixedType:SystemBooleanTruetotreatthepathasfixed,falsetotreatitasarelativepath.


SeeAlsoReference

publicFilePath(

stringpath,

boolisFixed,


)

CopyC# VB C++ F#



FilePathClassFilePathOverloadSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FilePathPropertiesTheFilePathtypeexposesthefollowingmembers.


BasePath Thisreturnsthebasepathfortheobject

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.


Path Thisisusedtogetorsetthepathtouse.

PersistablePath Thisisusedtoretrievethefile

pathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.

Top



[email protected]



HTMLtoMAMLConverter

FilePathBasePathPropertyThisreturnsthebasepathfortheobject


Syntax

PropertyValueType:StringIfnoIBasePathProviderhasbeenspecified,thisreturnsthecurrentdirectory



[email protected]

publicstringBasePath{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathBasePathProviderPropertyThisisusedtogetthebasepathproviderfortheobject.


Syntax

PropertyValueType:IBasePathProvider



[email protected]

publicIBasePathProviderBasePathProvider{get;}

CopyC# VB C++ F#



HTMLtoMAMLConverter

FilePathExistsPropertyThisread-onlypropertycanbeusedtodeterminewhetherornotthefilepathexists


Syntax




[email protected]

publicvirtualboolExists{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathExpandedPathPropertyThisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.


Syntax




[email protected]

publicstringExpandedPath{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathIsFixedPathPropertyThisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathePersistablePathproperty.


Syntax

PropertyValueType:BooleanIftrue,thepathisreturnedasafixedpathwhenretrieved.Iffalse,itisreturnedasapathrelativetothecurrentvalueoftheBasePathproperty.



[email protected]

publicboolIsFixedPath{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathPathPropertyThisisusedtogetorsetthepathtouse.


Syntax

PropertyValueType:StringWhenset,ifthepathisnotrooted(arelativepath),IsFixedPathissettofalse.Ifrooted(anabsolutepath),itisnotchanged.Thispropertyalwaysreturnsafullyqualifiedpathbutwithoutanyenvironmentvariableexpansions.Ifsettoanulloremptystring,thefilepathisclearedandisconsideredtobeundefined.

Examples

publicvirtualstringPath{get;set;}

Copy

FilePathpath=newFilePath();

//Setittoarelativepath

path.Path=@"..\..\Test.txt";

//Setittoanabsolutepath

path.Path=@"C:\MyDocuments\Info.doc";

//Setittoapathbasedonanenvironmentvariable

Copy

C# VB C++ F#

C# VB




[email protected]

path.Path=@"%HOMEDRIVE%%HOMEPATH%\Favorites\*.*";



HTMLtoMAMLConverter

FilePathPersistablePathPropertyThisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.


Syntax


RemarksIfIsFixedPathistrue,anabsolutepathisalwaysreturned.Iffalse,thepathisreturnedinaformthatisrelativetothepathstoredintheBasePathproperty.



[email protected]

publicvirtualstringPersistablePath{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathMethodsTheFilePathtypeexposesthefollowingmembers.


AbsoluteToRelativePath Thishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.

Clone Thisreturnsacloneoftheobject

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(OverridesObjectEquals(Object).)


GetFullPath Thisreturnsthefullyqualifiedpathforthespecifiedpath.This




versionallowswildcardsinthefilenamepartifpresent.

GetHashCode Getahashcodeforthefilepathobject(OverridesObjectGetHashCode.)



OnPersistablePathChanged ThisraisesthePersistablePathChangedevent

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent

RelativeToAbsolutePath Thishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.

ToString Convertthefilepathtoastring(OverridesObjectToString.)

Top











[email protected]



HTMLtoMAMLConverter

FilePathAbsoluteToRelativePathMethodThishelpermethodcanbeusedtoconvertanabsolutepathtoonethatisrelativetothegivenbasepath.


Syntax

Parameters

basePathType:SystemStringThebasepath

absolutePathType:SystemStringAnabsolutepath

ReturnValueType:StringApathtothegivenabsolutepaththatisrelativetothegivenbasepath

Remarks

publicstaticstringAbsoluteToRelativePath(

stringbasePath,

stringabsolutePath

)

CopyC# VB C++ F#




Ifthebasepathisnullorempty,thecurrentworkingfolderisused.

Examples



[email protected]

stringbasePath=@"E:\DotNet\CS\TestProject\Source"

stringabsolutePath=@"E:\DotNet\CS\TestProject\Doc\Help.html"

stringrelativePath=FilePath.AbsoluteToRelativePath(basePath,

absolutePath);

Console.WriteLine(relativePath);

//Resultsin:..\Doc\Help.html

CopyC# VB



HTMLtoMAMLConverter

FilePathCloneMethodThisreturnsacloneoftheobject


Syntax

ReturnValueType:ObjectAcloneoftheobjectImplementsICloneableClone



[email protected]

publicObjectClone()

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/9a2kzf4y



HTMLtoMAMLConverter

FilePathEqualsMethodThisisoverriddentoallowpropercomparisonoffilepathobjects.


Syntax

Parameters

objType:SystemObjectTheobjecttowhichthisinstanceiscompared

ReturnValueType:BooleanReturnstrueiftheobjectequalsthisinstance,falseifitdoesnot



[email protected]

publicoverrideboolEquals(

Objectobj

)

CopyC# VB C++ F#





HTMLtoMAMLConverter

FilePathGetFullPathMethodThisreturnsthefullyqualifiedpathforthespecifiedpath.Thisversionallowswildcardsinthefilenamepartifpresent.


Syntax

Parameters

pathType:SystemStringThepathtoexpand

ReturnValueType:StringThefullyqualifiedpathname

RemarksTheSystem.IO.PathversionofGetFullPath(String)willthrowanexceptionifthepathcontainswildcardcharacters.Thisversiondoesnot.

SeeAlso

publicstaticstringGetFullPath(

stringpath

)

CopyC# VB C++ F#



http://msdn2.microsoft.com/en-us/library/yx0f56k4

ReferenceFilePathClassSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FilePathGetHashCodeMethodGetahashcodeforthefilepathobject


Syntax

ReturnValueType:Int32ReturnsthehashcodeoftheToStringvalueconvertedtolowercase



[email protected]

publicoverrideintGetHashCode()

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathOnPersistablePathChangedMethodThisraisesthePersistablePathChangedevent


Syntax

Parameters

eType:SystemEventArgsTheeventarguments



[email protected]

protectedvoidOnPersistablePathChanged(

EventArgse

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathOnPersistablePathChangingMethodThisraisesthePersistablePathChangingevent


Syntax

Parameters

eType:SystemEventArgsTheeventarguments



[email protected]

protectedvoidOnPersistablePathChanging(

EventArgse

)

CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathRelativeToAbsolutePathMethodThishelpermethodcanbeusedtoconvertarelativepathtoanabsolutepathbasedonthegivenbasepath.


Syntax

Parameters

basePathType:SystemStringThebasepath

relativePathType:SystemStringArelativepath

ReturnValueType:StringAnabsolutepath

Remarks

publicstaticstringRelativeToAbsolutePath(

stringbasePath,

stringrelativePath

)

CopyC# VB C++ F#




Ifthebasepathisnullorempty,thecurrentworkingfolderisused.

Examples



[email protected]

stringbasePath=@"E:\DotNet\CS\TestProject\Source"

stringrelativePath=@"..\Doc\Help.html";

stringabsolutePath=FilePath.RelativeToAbsolutePath(basePath,

relativePath);

Console.WriteLine(absolutePath);

//Resultsin:E:\DotNet\CS\TestProject\Doc\Help.html

CopyC# VB



HTMLtoMAMLConverter

FilePathToStringMethodConvertthefilepathtoastring


Syntax

ReturnValueType:StringAfixedorrelativepathbasedonthecurrentsettings



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

FilePathEventsTheFilePathtypeexposesthefollowingmembers.


PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged

Top



[email protected]



HTMLtoMAMLConverter

FilePathPersistablePathChangedEventThiseventisraisedwhenthepersistablepathchanges


Syntax

ValueType:SystemEventHandler



[email protected]

publiceventEventHandlerPersistablePathChanged

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/xhb70ccc



HTMLtoMAMLConverter

FilePathPersistablePathChangingEventThiseventisraisedwhenthepersistablepathisabouttobechanged


Syntax

ValueType:SystemEventHandler



[email protected]

publiceventEventHandlerPersistablePathChanging

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/xhb70ccc



HTMLtoMAMLConverter

FilePathOperatorsandTypeConversionsTheFilePathtypeexposesthefollowingmembers.

Operators Name Description

Equality Overloadforequaloperator.

(FilePathtoString)

ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring

Inequality Overloadfornotequaloperator.

Top



[email protected]



HTMLtoMAMLConverter

FilePathEqualityOperatorOverloadforequaloperator.


Syntax

Parameters

firstPathType:SandcastleBuilder.UtilsFilePathThefirstobjecttocompare

secondPathType:SandcastleBuilder.UtilsFilePathThesecondobjecttocompare

ReturnValueType:BooleanTrueifequal,falseifnot.


publicstaticbooloperator==(

FilePathfirstPath,

FilePathsecondPath

)

CopyC# VB C++ F#



[email protected]



HTMLtoMAMLConverter

FilePathConversion(FilePathtoString)ThisisusedtohandleanimplicitconversionfromaFilePathobjecttoastring


Syntax

Parameters

filePathType:SandcastleBuilder.UtilsFilePathTheFilePathtoconvert.

ReturnValueType:StringThefilepathasarelativeorabsolutepathstringbasedonitscurrentsettings

Examples

publicstaticimplicitoperatorstring(

FilePathfilePath

)

Copy

FilePathfilePath=newFilePath(@"%APPDATA%\TestApp\App.config"

Copy

C# VB C++ F#

C# VB




[email protected]

//TheFilePathobjectisautomaticallyconvertedtoastring

//representingtheexpanded,fullyqualifiedpath.

stringpathString=filePath;



HTMLtoMAMLConverter

FilePathInequalityOperatorOverloadfornotequaloperator.


Syntax

Parameters

firstPathType:SandcastleBuilder.UtilsFilePathThefirstobjecttocompare

secondPathType:SandcastleBuilder.UtilsFilePathThesecondobjecttocompare

ReturnValueType:BooleanTrueifnotequal,falseiftheyare.


publicstaticbooloperator!=(

FilePathfirstPath,

FilePathsecondPath

)

CopyC# VB C++ F#



[email protected]



HTMLtoMAMLConverter

FolderPathClassThisclassisusedtorepresentafolderpath.Supportisincludedfortreatingthepathasfixedorrelativeandforexpandingenvironmentvariablesinthepathname.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsFilePathSandcastleBuilder.UtilsFolderPath


Syntax

TheFolderPathtypeexposesthefollowingmembers.


FolderPath(IBasePathProvider) Defaultconstructor.Thefolderpathisundefined.

FolderPath(String,IBasePathProvider)

Constructor.Assignthe


publicclassFolderPath:FilePath

CopyC# VB C++ F#


specifiedpath.

FolderPath(String,Boolean,IBasePathProvider)


Top


BasePath Thisreturnsthebasepathfortheobject(InheritedfromFilePath.)

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.(InheritedfromFilePath.)

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.(OverridesFilePathExists.)

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.(InheritedfromFilePath.)

IsFixedPath Thisisusedtoindicatewhetherornotthepathwillbetreatedasarelativeorfixedpathwhenconvertedretrievedviathe

PersistablePathproperty.(InheritedfromFilePath.)

Path Thisisusedtogetorsetthepath.(OverridesFilePathPath.)

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.(InheritedfromFilePath.)

Top


Clone Thisreturnsacloneoftheobject(InheritedfromFilePath.)

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(InheritedfromFilePath.)


GetHashCode Getahashcodeforthefilepathobject



(InheritedfromFilePath.)


IsPathTerminated Thiscanbeusedtofindoutifapathisterminatedwithatrailingbackslash.


OnPersistablePathChanged ThisraisesthePersistablePathChangedevent(InheritedfromFilePath.)

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent(InheritedfromFilePath.)

TerminatePath Thiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.

ToString Convertthefilepathtoastring(InheritedfromFilePath.)

Top








PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges(InheritedfromFilePath.)

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged(InheritedfromFilePath.)

Top



[email protected]



HTMLtoMAMLConverter

FolderPathConstructorTherearethreeoverloadsfortheconstructor.


FolderPath(IBasePathProvider) Defaultconstructor.Thefolderpathisundefined.

FolderPath(String,IBasePathProvider)


FolderPath(String,Boolean,IBasePathProvider)


Top

SeeAlsoReferenceFolderPathClassSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FolderPathConstructor(IBasePathProvider)Defaultconstructor.Thefolderpathisundefined.


Syntax

Parameters


SeeAlsoReferenceFolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace


[email protected]

publicFolderPath(


)

CopyC# VB C++ F#



HTMLtoMAMLConverter

FolderPathConstructor(String,IBasePathProvider)Constructor.Assignthespecifiedpath.


Syntax

Parameters



RemarksUnlessIsFixedPathissettotrue,thepathisalwaystreatedasarelativepath.

SeeAlso

publicFolderPath(

stringpath,


)

CopyC# VB C++ F#


ReferenceFolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FolderPathConstructor(String,Boolean,IBasePathProvider)Constructor.Assignthespecifiedpathandfixedsetting.


Syntax

Parameters


isFixedType:SystemBooleanTruetotreatthepathasfixed,falsetotreatitasarelativepath.


SeeAlsoReference

publicFolderPath(

stringpath,

boolisFixed,


)

CopyC# VB C++ F#



FolderPathClassFolderPathOverloadSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

FolderPathPropertiesTheFolderPathtypeexposesthefollowingmembers.


BasePath Thisreturnsthebasepathfortheobject(InheritedfromFilePath.)

BasePathProvider Thisisusedtogetthebasepathproviderfortheobject.(InheritedfromFilePath.)

Exists Thisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.(OverridesFilePathExists.)

ExpandedPath Thisread-onlypropertyisusedtodisplaythefullyqualifiedpathwithenvironmentvariableexpansionsinthedesigner.(InheritedfromFilePath.)


(InheritedfromFilePath.)

Path Thisisusedtogetorsetthepath.(OverridesFilePathPath.)

PersistablePath Thisisusedtoretrievethefilepathinaformatsuitableforpersistingtostoragebasedonthecurrentsettings.(InheritedfromFilePath.)

Top



[email protected]



HTMLtoMAMLConverter

FolderPathExistsPropertyThisread-onlypropertycanbeusedtodeterminewhetherornotthefolderpathexists.


Syntax




[email protected]

publicoverrideboolExists{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

FolderPathPathPropertyThisisusedtogetorsetthepath.


Syntax

PropertyValueType:StringWhenset,ifthepathisnotrooted(arelativepath),IsFixedPathissettofalse.Ifrooted(anabsolutepath),itisnotchanged.Thispropertyalwaysreturnsafullyqualifiedpathbutwithoutanyenvironmentvariableexpansionsandterminatedwithatrailingbackslashifneeded.Ifsettoanulloremptystring,thefolderpathisclearedandisconsideredtobeundefined.

Examples

publicoverridestringPath{get;set;}

Copy

FolderPathpath=newFolderPath();

//Setittoarelativepath

path.Path=@"..\..\ProjectFolder";

//Setittoanabsolutepath

path.Path=@"C:\MyDocuments\ProjectDocs\";

Copy

C# VB C++ F#

C# VB




[email protected]

//Setittoapathbasedonanenvironmentvariable

path.Path=@"%HOMEDRIVE%%HOMEPATH%\Favorites\";



HTMLtoMAMLConverter

FolderPathMethodsTheFolderPathtypeexposesthefollowingmembers.


Clone Thisreturnsacloneoftheobject(InheritedfromFilePath.)

Equals Thisisoverriddentoallowpropercomparisonoffilepathobjects.(InheritedfromFilePath.)


GetHashCode Getahashcodeforthefilepathobject(InheritedfromFilePath.)


IsPathTerminated Thiscanbeusedtofindoutifapathisterminated






withatrailingbackslash.


OnPersistablePathChanged ThisraisesthePersistablePathChangedevent(InheritedfromFilePath.)

OnPersistablePathChanging ThisraisesthePersistablePathChangingevent(InheritedfromFilePath.)

TerminatePath Thiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.

ToString Convertthefilepathtoastring(InheritedfromFilePath.)

Top



[email protected]






HTMLtoMAMLConverter

FolderPathIsPathTerminatedMethodThiscanbeusedtofindoutifapathisterminatedwithatrailingbackslash.


Syntax

Parameters

pathType:SystemStringThepathtocheck

ReturnValueType:BooleanReturnstrueifitis,falseifitisnot.


publicstaticboolIsPathTerminated(

stringpath

)

CopyC# VB C++ F#




[email protected]



HTMLtoMAMLConverter

FolderPathTerminatePathMethodThiscanbeusedtoensurethatapathisterminatedwithatrailingbackslash.


Syntax

Parameters

pathType:SystemStringThepathtocheck

ReturnValueType:StringThepathwithatrailingbackslashaddedifnecessary.


publicstaticstringTerminatePath(

stringpath

)

CopyC# VB C++ F#




[email protected]



HTMLtoMAMLConverter

FolderPathEventsTheFolderPathtypeexposesthefollowingmembers.


PersistablePathChanged Thiseventisraisedwhenthepersistablepathchanges(InheritedfromFilePath.)

PersistablePathChanging Thiseventisraisedwhenthepersistablepathisabouttobechanged(InheritedfromFilePath.)

Top



[email protected]



HTMLtoMAMLConverter

IBasePathProviderInterfaceThisinterfacedefinesthepropertiesusedtoobtainabasepathforaFilePathobject.


Syntax

TheIBasePathProvidertypeexposesthefollowingmembers.


BasePath Thisread-onlypropertyreturnsthebasepath

Top



[email protected]

publicinterfaceIBasePathProvider

CopyC# VB C++ F#



HTMLtoMAMLConverter

IBasePathProviderPropertiesTheIBasePathProvidertypeexposesthefollowingmembers.


BasePath Thisread-onlypropertyreturnsthebasepath

Top

SeeAlsoReferenceIBasePathProviderInterfaceSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

IBasePathProviderBasePathPropertyThisread-onlypropertyreturnsthebasepath


Syntax


SeeAlsoReferenceIBasePathProviderInterfaceSandcastleBuilder.UtilsNamespace


[email protected]

stringBasePath{get;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrClassThisrepresentsanHTMLHelp2.xattributethatcanbeaddedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsMSHelpAttr


Syntax

TheMSHelpAttrtypeexposesthefollowingmembers.


AttributeName Thisisusedtogetorsettheattributename

AttributeValue Thisisusedtogetorsettheattributevalue

IsDirty Thisisusedtogetorsetthedirtystateoftheitem


publicclassMSHelpAttr:IComparable<MSHelpAttr>

CopyC# VB C++ F#


Top


CompareTo Comparesthisinstancetoanotherinstanceandreturnsanindicationoftheirrelativevalues.

Equals Determineswhetherthespecifiedobjectisequaltothecurrentobject.(OverridesObjectEquals(Object).)


GetHashCode Getahashcodeforthisitem(OverridesObjectGetHashCode.)



ToString Returnastringrepresentationoftheitem











(OverridesObjectToString.)

Top



[email protected]




HTMLtoMAMLConverter

MSHelpAttrPropertiesTheMSHelpAttrtypeexposesthefollowingmembers.


AttributeName Thisisusedtogetorsettheattributename

AttributeValue Thisisusedtogetorsettheattributevalue

IsDirty Thisisusedtogetorsetthedirtystateoftheitem

Top

SeeAlsoReferenceMSHelpAttrClassSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

MSHelpAttrAttributeNamePropertyThisisusedtogetorsettheattributename


Syntax




[email protected]

publicstringAttributeName{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrAttributeValuePropertyThisisusedtogetorsettheattributevalue


Syntax




[email protected]

publicstringAttributeValue{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrIsDirtyPropertyThisisusedtogetorsetthedirtystateoftheitem


Syntax




[email protected]

publicboolIsDirty{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrMethodsTheMSHelpAttrtypeexposesthefollowingmembers.







MemberwiseClone Createsashallowcopyofthe









currentObject.(InheritedfromObject.)

ToString Returnastringrepresentationoftheitem(OverridesObjectToString.)

Top



[email protected]






HTMLtoMAMLConverter

MSHelpAttrCompareToMethodComparesthisinstancetoanotherinstanceandreturnsanindicationoftheirrelativevalues.


Syntax

Parameters

otherType:SandcastleBuilder.UtilsMSHelpAttrAMSHelpAttrobjecttocompare

ReturnValueType:Int32Returns-1ifthisinstanceislessthanthevalue,0iftheyareequal,or1ifthisinstanceisgreaterthanthevalueorthevalueisnull.ImplementsIComparableTCompareTo(T)

RemarksEntriesaresortedbynameandthenvalue

publicintCompareTo(

MSHelpAttrother

)

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/43hc6wht



[email protected]



HTMLtoMAMLConverter

MSHelpAttrEqualsMethodDetermineswhetherthespecifiedobjectisequaltothecurrentobject.


Syntax

Parameters

objType:SystemObjectTheobjecttocomparewiththecurrentobject.

ReturnValueType:Booleantrueifthespecifiedobjectisequaltothecurrentobject;otherwise,false.



[email protected]


Objectobj

)

CopyC# VB C++ F#





HTMLtoMAMLConverter

MSHelpAttrGetHashCodeMethodGetahashcodeforthisitem


Syntax

ReturnValueType:Int32Returnsthehashcodefortheattributenameandvalue.



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrToStringMethodReturnastringrepresentationoftheitem


Syntax

ReturnValueType:StringReturnstheiteminitsXMLformat



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrCollectionClassThiscollectionclassisusedtoholdthehelpattributeitemsforaproject.

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionMSHelpAttrSystem.ComponentModelBindingListMSHelpAttrSandcastleBuilder.UtilsMSHelpAttrCollection


Syntax

TheMSHelpAttrCollectiontypeexposesthefollowingmembers.


MSHelpAttrCollection Constructor

Top


publicclassMSHelpAttrCollection:BindingList<MSHelpAttr

CopyC# VB C++ F#




AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpAttr.)

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpAttr.)

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpAttr.)

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionMSHelpAttr.)

IsDirty Thisisusedtogetorsetthedirtystateofthecollection

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(Inheritedfrom












BindingListMSHelpAttr.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionMSHelpAttr.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpAttr.)

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpAttr.)

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpAttr.)

SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpAttr.)

SupportsChangeNotificationCore GetsavalueindicatingwhetherListChanged

















eventsareenabled.(InheritedfromBindingListMSHelpAttr.)

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(InheritedfromBindingListMSHelpAttr.)

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpAttr.)

Top


Add(T) AddsanobjecttotheendoftheCollection(InheritedfromCollectionMSHelpAttr

Add(String,String) Addanewitemtothecollection

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpAttr

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpAttr

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException(InheritedfromBindingListMSHelpAttr

CancelNew Discardsapendingnewitem.














http://msdn2.microsoft.com/en-us/library/8a7a4e64



(InheritedfromBindingListMSHelpAttr

Clear RemovesallelementsfromtheCollection(InheritedfromCollectionMSHelpAttr

ClearItems Removesallelementsfromthecollection.(InheritedfromBindingListMSHelpAttr

Contains Determineswhetheranelementisinthe(InheritedfromCollectionMSHelpAttr

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionMSHelpAttr

EndNew Commitsapendingnewitemtothecollection.(InheritedfromBindingListMSHelpAttr



FindCore Searchesfortheindexoftheitemthathasthespecifiedpropertydescriptorwiththespecifiedvalue,ifsearchingisimplementedinaderivedclass;otherwise,aNotSupportedException(InheritedfromBindingListMSHelpAttr

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionMSHelpAttr



























IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionMSHelpAttr

Insert InsertsanelementintotheCollectionspecifiedindex.(InheritedfromCollectionMSHelpAttr

InsertItem Insertsthespecifiediteminthelistatthespecifiedindex.(InheritedfromBindingListMSHelpAttr

MarkAsDirty Thisisusedtomarkthecollectionaschangedwhenthereisnoassociatedproject.

MemberwiseClone Createsashallowcopyofthecurrent(InheritedfromObject.)

OnAddingNew RaisestheAddingNewevent.(InheritedfromBindingListMSHelpAttr

OnListChanged Thisisoverriddentomarkthecollectionasdirtywhenitchanges(OverridesBindingListTOnListChanged(ListChangedEventArgs)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionMSHelpAttr

RemoveAt Removestheelementatthespecifiedindexofthe

























CollectionT.(InheritedfromCollectionMSHelpAttr

RemoveItem Removestheitematthespecifiedindex.(InheritedfromBindingListMSHelpAttr

RemoveSortCore RemovesanysortappliedwithApplySortCore(PropertyDescriptor,ListSortDirection)ifsortingisimplementedinaderivedclass;otherwise,raisesNotSupportedException.(InheritedfromBindingListMSHelpAttr

ResetBindings RaisesaListChangedeventoftype(InheritedfromBindingListMSHelpAttr

ResetItem RaisesaListChangedeventoftypetheitematthespecifiedposition.(InheritedfromBindingListMSHelpAttr

SetItem Replacestheitematthespecifiedindexwiththespecifieditem.(InheritedfromBindingListMSHelpAttr


ToConfigurationString Convertthecollectiontoitsstringformforuseinthesandcastle.configfile.


WriteXml WritethecollectiontothegivenXMLtextwriter

Top





















AddingNew Occursbeforeanitemisaddedtothelist.(InheritedfromBindingListMSHelpAttr.)

ListChanged Occurswhenthelistoraniteminthelistchanges.(InheritedfromBindingListMSHelpAttr.)

Top



[email protected]

http://msdn2.microsoft.com/en-us/library/9ctay6d0








HTMLtoMAMLConverter

MSHelpAttrCollectionConstructorConstructor


Syntax

SeeAlsoReferenceMSHelpAttrCollectionClassSandcastleBuilder.UtilsNamespace


[email protected]

publicMSHelpAttrCollection()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpAttrCollectionPropertiesTheMSHelpAttrCollectiontypeexposesthefollowingmembers.


AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpAttr.)

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpAttr.)

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpAttr.)

Count GetsthenumberofelementsactuallycontainedintheCollectionT.










(InheritedfromCollectionMSHelpAttr.)

IsDirty Thisisusedtogetorsetthedirtystateofthecollection

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(InheritedfromBindingListMSHelpAttr.)

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionMSHelpAttr.)

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpAttr.)

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpAttr.)

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpAttr.)















SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpAttr.)

SupportsChangeNotificationCore GetsavalueindicatingwhetherListChangedeventsareenabled.(InheritedfromBindingListMSHelpAttr.)

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(InheritedfromBindingListMSHelpAttr.)

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpAttr.)

Top



[email protected]












HTMLtoMAMLConverter

MSHelpAttrCollectionIsDirtyPropertyThisisusedtogetorsetthedirtystateofthecollection


Syntax




[email protected]

publicboolIsDirty{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrCollectionMethodsTheMSHelpAttrCollectiontypeexposesthefollowingmembers.


Add(T) AddsanobjecttotheendoftheCollection(InheritedfromCollectionMSHelpAttr

Add(String,String) Addanewitemtothecollection

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpAttr

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpAttr

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException(InheritedfromBindingListMSHelpAttr

CancelNew Discardsapendingnewitem.(InheritedfromBindingListMSHelpAttr

Clear RemovesallelementsfromtheCollection(InheritedfromCollectionMSHelpAttr

ClearItems Removesallelementsfromthecollection.(InheritedfromBindingListMSHelpAttr

Contains Determineswhetheranelementisinthe(InheritedfromCollectionMSHelpAttr




















CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionMSHelpAttr

EndNew Commitsapendingnewitemtothecollection.(InheritedfromBindingListMSHelpAttr



FindCore Searchesfortheindexoftheitemthathasthespecifiedpropertydescriptorwiththespecifiedvalue,ifsearchingisimplementedinaderivedclass;otherwise,aNotSupportedException(InheritedfromBindingListMSHelpAttr

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionMSHelpAttr



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionMSHelpAttr


























Insert InsertsanelementintotheCollectionspecifiedindex.(InheritedfromCollectionMSHelpAttr

InsertItem Insertsthespecifiediteminthelistatthespecifiedindex.(InheritedfromBindingListMSHelpAttr


MemberwiseClone Createsashallowcopyofthecurrent(InheritedfromObject.)

OnAddingNew RaisestheAddingNewevent.(InheritedfromBindingListMSHelpAttr

OnListChanged Thisisoverriddentomarkthecollectionasdirtywhenitchanges(OverridesBindingListTOnListChanged(ListChangedEventArgs)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionMSHelpAttr

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionMSHelpAttr

RemoveItem Removestheitematthespecifiedindex.(InheritedfromBindingListMSHelpAttr

RemoveSortCore RemovesanysortappliedwithApplySortCore(PropertyDescriptor,ListSortDirection)ifsortingisimplementedinaderivedclass;otherwise,raisesNotSupportedException.(InheritedfromBindingListMSHelpAttr
























ResetBindings RaisesaListChangedeventoftype(InheritedfromBindingListMSHelpAttr

ResetItem RaisesaListChangedeventoftypetheitematthespecifiedposition.(InheritedfromBindingListMSHelpAttr

SetItem Replacestheitematthespecifiedindexwiththespecifieditem.(InheritedfromBindingListMSHelpAttr


ToConfigurationString Convertthecollectiontoitsstringformforuseinthesandcastle.configfile.


WriteXml WritethecollectiontothegivenXMLtextwriter

Top



[email protected]
















HTMLtoMAMLConverter

MSHelpAttrCollectionAddMethod


Add(T) AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionMSHelpAttr.)

Add(String,String)

Addanewitemtothecollection

Top



[email protected]






HTMLtoMAMLConverter

MSHelpAttrCollectionAddMethod(String,String)Addanewitemtothecollection


Syntax

Parameters

nameType:SystemStringTheattributename

valueType:SystemStringTheattributevalue

ReturnValueType:MSHelpAttrTheMSHelpAttraddedtotheproject.IfIftheitemalreadyexistsinthecollection,theexistingitemisreturned.

Remarks

publicMSHelpAttrAdd(

stringname,

stringvalue

)

CopyC# VB C++ F#



TheMSHelpAttrconstructorisinternalsothatwecontrolcreationoftheitemsandcanassociatethemwiththeproject.

SeeAlsoReferenceMSHelpAttrCollectionClassAddOverloadSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

MSHelpAttrCollectionMarkAsDirtyMethodThisisusedtomarkthecollectionaschangedwhenthereisnoassociatedproject.


Syntax



[email protected]

publicvoidMarkAsDirty()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpAttrCollectionOnListChangedMethodThisisoverriddentomarkthecollectionasdirtywhenitchanges


Syntax

Parameters

eType:System.ComponentModelListChangedEventArgsTheeventarguments



[email protected]

protectedoverridevoidOnListChanged(

ListChangedEventArgse

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/t5xxd0fk



HTMLtoMAMLConverter

MSHelpAttrCollectionSortMethodThisisusedtosortthecollection


Syntax

RemarksValuesaresortedbyattributenameandvalue



[email protected]

publicvoidSort()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpAttrCollectionToConfigurationStringMethodConvertthecollectiontoitsstringformforuseinthesandcastle.configfile.


Syntax

ReturnValueType:StringThehelpattributecollectioninstringformreadyforuseintheSandcastleBuildAssemblerconfigurationfile.



[email protected]

publicstringToConfigurationString()

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpAttrCollectionWriteXmlMethodWritethecollectiontothegivenXMLtextwriter


Syntax

Parameters

xwType:System.XmlXmlWriterTheXMLtextwritertowhichtheinformationiswritten.

includeContainerType:SystemBooleanTruetowriteoutthecontainingHelpAttributeselement,falsetoexcludeit.


publicvoidWriteXml(

XmlWriterxw,

boolincludeContainer

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/5y8188ze



[email protected]



HTMLtoMAMLConverter

MSHelpAttrCollectionEventsTheMSHelpAttrCollectiontypeexposesthefollowingmembers.


AddingNew Occursbeforeanitemisaddedtothelist.(InheritedfromBindingListMSHelpAttr.)

ListChanged Occurswhenthelistoraniteminthelistchanges.(InheritedfromBindingListMSHelpAttr.)

Top



[email protected]







HTMLtoMAMLConverter

MSHelpKeywordClassThisrepresentsanHTMLHelp2.xindexkeywordthatcanbeaddedtotheXMLdataislandineachhelptopicgeneratedbyBuildAssembler.

InheritanceHierarchySystemObjectSandcastleBuilder.UtilsMSHelpKeyword


Syntax

TheMSHelpKeywordtypeexposesthefollowingmembers.


MSHelpKeyword Constructor

MSHelpKeyword(String,String) Constructor

Top

Properties


publicclassMSHelpKeyword:IComparable<MSHelpKeyword

CopyC# VB C++ F#


Name Description

Index Thisisusedtogetorsettheindexname

Term Thisisusedtogetorsettheindexterm

Top
















Top



[email protected]







HTMLtoMAMLConverter

MSHelpKeywordConstructor


MSHelpKeyword Constructor

MSHelpKeyword(String,String) Constructor

Top

SeeAlsoReferenceMSHelpKeywordClassSandcastleBuilder.UtilsNamespace


[email protected]



HTMLtoMAMLConverter

MSHelpKeywordConstructorConstructor


Syntax

RemarksTheindexnamedefaultsto"K"

SeeAlsoReferenceMSHelpKeywordClassMSHelpKeywordOverloadSandcastleBuilder.UtilsNamespace


[email protected]

publicMSHelpKeyword()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpKeywordConstructor(String,String)Constructor


Syntax

Parameters

indexNameType:SystemStringTheindexname

keywordTermType:SystemStringTheindexterm

SeeAlsoReferenceMSHelpKeywordClassMSHelpKeywordOverloadSandcastleBuilder.UtilsNamespace

publicMSHelpKeyword(

stringindexName,

stringkeywordTerm

)

CopyC# VB C++ F#




[email protected]



HTMLtoMAMLConverter

MSHelpKeywordPropertiesTheMSHelpKeywordtypeexposesthefollowingmembers.


Index Thisisusedtogetorsettheindexname

Term Thisisusedtogetorsettheindexterm

Top



[email protected]



HTMLtoMAMLConverter

MSHelpKeywordIndexPropertyThisisusedtogetorsettheindexname


Syntax




[email protected]

publicstringIndex{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpKeywordTermPropertyThisisusedtogetorsettheindexterm


Syntax




[email protected]

publicstringTerm{get;set;}

CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpKeywordMethodsTheMSHelpKeywordtypeexposesthefollowingmembers.







MemberwiseClone Createsashallowcopyofthe









currentObject.(InheritedfromObject.)


Top



[email protected]






HTMLtoMAMLConverter

MSHelpKeywordCompareToMethodComparesthisinstancetoanotherinstanceandreturnsanindicationoftheirrelativevalues.


Syntax

Parameters

otherType:SandcastleBuilder.UtilsMSHelpKeywordAMSHelpKeywordobjecttocompare

ReturnValueType:Int32Returns-1ifthisinstanceislessthanthevalue,0iftheyareequal,or1ifthisinstanceisgreaterthanthevalueorthevalueisnull.ImplementsIComparableTCompareTo(T)

RemarksEntriesaresortedbynameandthenvalue

publicintCompareTo(

MSHelpKeywordother

)

CopyC# VB C++ F#


http://msdn2.microsoft.com/en-us/library/43hc6wht



[email protected]



HTMLtoMAMLConverter

MSHelpKeywordEqualsMethodDetermineswhetherthespecifiedobjectisequaltothecurrentobject.


Syntax

Parameters

objType:SystemObjectTheobjecttocomparewiththecurrentobject.

ReturnValueType:Booleantrueifthespecifiedobjectisequaltothecurrentobject;otherwise,false.



[email protected]


Objectobj

)

CopyC# VB C++ F#





HTMLtoMAMLConverter

MSHelpKeywordGetHashCodeMethodGetahashcodeforthisitem


Syntax

ReturnValueType:Int32Returnsthehashcodefortheindexnameandterm.



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpKeywordToStringMethodReturnastringrepresentationoftheitem


Syntax

ReturnValueType:StringReturnstheiteminitsXMLformat



[email protected]


CopyC# VB C++ F#




HTMLtoMAMLConverter

MSHelpKeywordCollectionClassThiscollectionclassisusedtoholdthehelpindexkeyworditemsforaproject.

InheritanceHierarchySystemObjectSystem.Collections.ObjectModelCollectionMSHelpKeywordSystem.ComponentModelBindingListMSHelpKeywordSandcastleBuilder.UtilsMSHelpKeywordCollection


Syntax

TheMSHelpKeywordCollectiontypeexposesthefollowingmembers.


MSHelpKeywordCollection InitializesanewinstanceoftheMSHelpKeywordCollectionclass

Top

publicclassMSHelpKeywordCollection:BindingList<

CopyC# VB C++ F#





AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpKeyword

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpKeyword

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpKeyword

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(InheritedfromCollectionMSHelpKeyword

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(InheritedfromBindingListMSHelpKeyword

Item Getsorsetstheelementatthespecifiedindex.














(InheritedfromCollectionMSHelpKeyword

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpKeyword

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpKeyword

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpKeyword

SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpKeyword

SupportsChangeNotificationCore GetsavalueindicatingwhetherListChangedeventsareenabled.(InheritedfromBindingListMSHelpKeyword

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(Inheritedfrom

















BindingListMSHelpKeyword

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpKeyword

Top


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpKeyword.)

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpKeyword.)

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException.(InheritedfromBindingListMSHelpKeyword.)

CancelNew Discardsapendingnewitem.(InheritedfromBindingListMSHelpKeyword.)
















Clear RemovesallelementsfromtheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

ClearItems Removesallelementsfromthecollection.(InheritedfromBindingListMSHelpKeyword.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionMSHelpKeyword.)

EndNew Commitsapendingnewitemtothecollection.(InheritedfromBindingListMSHelpKeyword.)





















FindCore Searchesfortheindexoftheitemthathasthespecifiedpropertydescriptorwiththespecifiedvalue,ifsearchingisimplementedinaderivedclass;otherwise,aNotSupportedException.(InheritedfromBindingListMSHelpKeyword.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionMSHelpKeyword.)



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionMSHelpKeyword.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionMSHelpKeyword.)

InsertItem Insertsthespecifiediteminthelistatthespecifiedindex.(InheritedfromBindingListMSHelpKeyword.)






















OnAddingNew RaisestheAddingNewevent.(InheritedfromBindingListMSHelpKeyword.)

OnListChanged RaisestheListChangedevent.(InheritedfromBindingListMSHelpKeyword.)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

RemoveItem Removestheitematthespecifiedindex.(InheritedfromBindingListMSHelpKeyword.)

RemoveSortCore RemovesanysortappliedwithApplySortCore(PropertyDescriptor,ListSortDirection)ifsortingisimplementedinaderivedclass;otherwise,raises




















NotSupportedException.(InheritedfromBindingListMSHelpKeyword.)

ResetBindings RaisesaListChangedeventoftypeReset.(InheritedfromBindingListMSHelpKeyword.)

ResetItem RaisesaListChangedeventoftypeItemChangedfortheitematthespecifiedposition.(InheritedfromBindingListMSHelpKeyword.)

SetItem Replacestheitematthespecifiedindexwiththespecifieditem.(InheritedfromBindingListMSHelpKeyword.)



WriteXml Thisisusedtosavethekeywordcollectiontotheprojectfile.

Top


AddingNew Occursbeforeanitemisaddedtothelist.(Inheritedfrom
















BindingListMSHelpKeyword.)

ListChanged Occurswhenthelistoraniteminthelistchanges.(InheritedfromBindingListMSHelpKeyword.)

Top



[email protected]






HTMLtoMAMLConverter

MSHelpKeywordCollectionConstructorInitializesanewinstanceoftheMSHelpKeywordCollectionclass


Syntax

SeeAlsoReferenceMSHelpKeywordCollectionClassSandcastleBuilder.UtilsNamespace


[email protected]

publicMSHelpKeywordCollection()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpKeywordCollectionPropertiesTheMSHelpKeywordCollectiontypeexposesthefollowingmembers.


AllowEdit Getsorsetsavalueindicatingwhetheritemsinthelistcanbeedited.(InheritedfromBindingListMSHelpKeyword

AllowNew GetsorsetsavalueindicatingwhetheryoucanadditemstothelistusingtheAddNewmethod.(InheritedfromBindingListMSHelpKeyword

AllowRemove Getsorsetsavalueindicatingwhetheryoucanremoveitemsfromthecollection.(InheritedfromBindingListMSHelpKeyword

Count GetsthenumberofelementsactuallycontainedintheCollectionT.(Inheritedfrom










CollectionMSHelpKeyword

IsSortedCore Getsavalueindicatingwhetherthelistissorted.(InheritedfromBindingListMSHelpKeyword

Item Getsorsetstheelementatthespecifiedindex.(InheritedfromCollectionMSHelpKeyword

Items GetsaIListTwrapperaroundtheCollectionT.(InheritedfromCollectionMSHelpKeyword

RaiseListChangedEvents GetsorsetsavalueindicatingwhetheraddingorremovingitemswithinthelistraisesListChangedevents.(InheritedfromBindingListMSHelpKeyword

SortDirectionCore Getsthedirectionthelistissorted.(InheritedfromBindingListMSHelpKeyword

SortPropertyCore Getsthepropertydescriptorthatisusedforsortingthelistifsortingisimplementedinaderivedclass;otherwise,returnsnull.(InheritedfromBindingListMSHelpKeyword

SupportsChangeNotificationCore Getsavalueindicating


















whetherListChangedeventsareenabled.(InheritedfromBindingListMSHelpKeyword

SupportsSearchingCore Getsavalueindicatingwhetherthelistsupportssearching.(InheritedfromBindingListMSHelpKeyword

SupportsSortingCore Getsavalueindicatingwhetherthelistsupportssorting.(InheritedfromBindingListMSHelpKeyword

Top



[email protected]









HTMLtoMAMLConverter

MSHelpKeywordCollectionMethodsTheMSHelpKeywordCollectiontypeexposesthefollowingmembers.


Add AddsanobjecttotheendoftheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

AddNew Addsanewitemtothecollection.(InheritedfromBindingListMSHelpKeyword.)

AddNewCore Addsanewitemtotheendofthecollection.(InheritedfromBindingListMSHelpKeyword.)

ApplySortCore Sortstheitemsifoverriddeninaderivedclass;otherwise,throwsaNotSupportedException.(InheritedfromBindingListMSHelpKeyword.)

CancelNew Discardsapendingnewitem.(InheritedfromBindingListMSHelpKeyword.)

Clear Removesallelementsfromthe














CollectionT.(InheritedfromCollectionMSHelpKeyword.)

ClearItems Removesallelementsfromthecollection.(InheritedfromBindingListMSHelpKeyword.)

Contains DetermineswhetheranelementisintheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

CopyTo CopiestheentireCollectionTtoacompatibleone-dimensionalArray,startingatthespecifiedindexofthetargetarray.(InheritedfromCollectionMSHelpKeyword.)

EndNew Commitsapendingnewitemtothecollection.(InheritedfromBindingListMSHelpKeyword.)



FindCore Searchesfortheindexoftheitem



















thathasthespecifiedpropertydescriptorwiththespecifiedvalue,ifsearchingisimplementedinaderivedclass;otherwise,aNotSupportedException.(InheritedfromBindingListMSHelpKeyword.)

GetEnumerator ReturnsanenumeratorthatiteratesthroughtheCollectionT.(InheritedfromCollectionMSHelpKeyword.)



IndexOf Searchesforthespecifiedobjectandreturnsthezero-basedindexofthefirstoccurrencewithintheentireCollectionT.(InheritedfromCollectionMSHelpKeyword.)

Insert InsertsanelementintotheCollectionTatthespecifiedindex.(InheritedfromCollectionMSHelpKeyword.)

InsertItem Insertsthespecifiediteminthelistatthespecifiedindex.(InheritedfromBindingListMSHelpKeyword.)





















OnAddingNew RaisestheAddingNewevent.(InheritedfromBindingListMSHelpKeyword.)

OnListChanged RaisestheListChangedevent.(InheritedfromBindingListMSHelpKeyword.)

Remove RemovesthefirstoccurrenceofaspecificobjectfromtheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

RemoveAt RemovestheelementatthespecifiedindexoftheCollectionT.(InheritedfromCollectionMSHelpKeyword.)

RemoveItem Removestheitematthespecifiedindex.(InheritedfromBindingListMSHelpKeyword.)

RemoveSortCore RemovesanysortappliedwithApplySortCore(PropertyDescriptor,ListSortDirection)ifsortingisimplementedinaderivedclass;otherwise,raisesNotSupportedException.





















(InheritedfromBindingListMSHelpKeyword.)

ResetBindings RaisesaListChangedeventoftypeReset.(InheritedfromBindingListMSHelpKeyword.)

ResetItem RaisesaListChangedeventoftypeItemChangedfortheitematthespecifiedposition.(InheritedfromBindingListMSHelpKeyword.)

SetItem Replacestheitematthespecifiedindexwiththespecifieditem.(InheritedfromBindingListMSHelpKeyword.)



WriteXml Thisisusedtosavethekeywordcollectiontotheprojectfile.

Top

















[email protected]


HTMLtoMAMLConverter

MSHelpKeywordCollectionMarkAsDirtyMethodThisisusedtomarkthecollectionaschangedwhenthereisnoassociatedproject.


Syntax



[email protected]

publicvoidMarkAsDirty()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpKeywordCollectionSortMethodThisisusedtosortthecollection


Syntax

RemarksValuesaresortedbyindexnameandterm



[email protected]

publicvoidSort()

CopyC# VB C++ F#



HTMLtoMAMLConverter

MSHelpKeywordCollectionWriteXmlMethodThisisusedtosavethekeywordcollectiontotheprojectfile.


Syntax

Parameters

xwType:System.XmlXmlWriterTheXMLtextwritertowhichtheinformationiswritten.



[email protected]

publicvoidWriteXml(

XmlWriterxw

)

CopyC# VB C++ F#

http://msdn2.microsoft.com/en-us/library/5y8188ze



HTMLtoMAMLConverter

MSHelpKeywordCollectionEventsTheMSHelpKeywordCollectiontypeexposesthefollowingmembers.


AddingNew Occursbeforeanitemisaddedtothelist.(InheritedfromBindingListMSHelpKeyword.)

ListChanged Occurswhenthelistoraniteminthelistchanges.(InheritedfromBindingListMSHelpKeyword.)

Top



[email protected]