Introduction:
In this article you will see how to get the check in comment for a
document in SharePoint 2010 using ECMAScript. I have a document library
named
“Shared Documents†which has the following document.
I am going to get the check in comment for a document.
Steps Involved:
1. Navigate to the SharePoint site (I have a site page created in my
site where I am going to add the content editor web part).
2. Go to
Site Actions, click on
Edit Page.
3. Click on
Insert tab in the ribbon interface and then click on
Web Part button.
4. Select
Media and Content in the
Categories section and then click on
Content Editor.
5. Click on
Add.
6.
Content editor web part will be added to the site page.
7. Click on down arrow and then click on
Edit Web Part.
8. Click on
“Click here to add new contentâ€Â. 
9. Click
on Format Text tab in the ribbon interface and then click on
HTML drop down.
10. Click on
Edit HTML source.
11.
HTML source window will pop up.
12. Copy and paste the following script.
<script language="ecmascript" type="text/ecmascript">
var item;
var list;
var file;
function fileCheckInComment() {
var clientContext = SP.ClientContext.get_current();
if (clientContext != undefined && clientContext != null) {
var webSite = clientContext.get_web();
this.list = webSite.get_lists().getByTitle("Shared Documents");
this.item = list.getItemById(16);
this.file = this.item.get_file();
clientContext.load(this.file);
clientContext.executeQueryAsync(Function.createDelegate(this, this.OnLoadSuccess), Function.createDelegate(this, this.OnLoadFailed));
}
}
function OnLoadSuccess(sender, args) {
var version = "Check in comment: " + this.file.get_checkInComment();
alert(version)
}
function OnLoadFailed(sender, args) {
alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
}</script>
<input id="btnfileCheckInComment" onclick="fileCheckInComment()" type="button" value="File Check in Comment" />
|
13. Click on Ok.
14. In the ribbon interface click on
Save & Close button.
15. In the content editor web part you could find a button named
“File Check in Commentâ€Â, click on that button.
16. Alert will pop up which displays the following.
Reference: 1.
SP.File.checkInComment Property - http://msdn.microsoft.com/en-us/library/ee554049.aspx
Summary: Thus in this article you have seen how to get the check in comment for a document in SharePoint 2010 using ECMAScript.